KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QClipboard

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QClipboard

Class hierarchy: QClipboard » QObject

Sub-classes: Mode, QFlags_Mode

Public methods

[const]QClipboard ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[signal]voidchanged(const QClipboard_Mode mode)Signal declaration for QClipboard::changed(QClipboard::Mode mode)
voidclear(const QClipboard_Mode mode = QClipboard::Clipboard)Method void QClipboard::clear(QClipboard::Mode mode)
[signal]voiddataChangedSignal declaration for QClipboard::dataChanged()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QClipboard::destroyed(QObject *)
[signal]voidfindBufferChangedSignal declaration for QClipboard::findBufferChanged()
[const]QImageimage(const QClipboard_Mode mode = QClipboard::Clipboard)Method QImage QClipboard::image(QClipboard::Mode mode)
[const]const QMimeData ptrmimeData(const QClipboard_Mode mode = QClipboard::Clipboard)Method const QMimeData *QClipboard::mimeData(QClipboard::Mode mode)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QClipboard::objectNameChanged(const QString &objectName)
[const]boolownsClipboardMethod bool QClipboard::ownsClipboard()
[const]boolownsFindBufferMethod bool QClipboard::ownsFindBuffer()
[const]boolownsSelectionMethod bool QClipboard::ownsSelection()
[const]QPixmappixmap(const QClipboard_Mode mode = QClipboard::Clipboard)Method QPixmap QClipboard::pixmap(QClipboard::Mode mode)
[signal]voidselectionChangedSignal declaration for QClipboard::selectionChanged()
voidsetImage(const QImage arg1,
const QClipboard_Mode mode = QClipboard::Clipboard)
Method void QClipboard::setImage(const QImage &, QClipboard::Mode mode)
voidsetMimeData(QMimeData ptr data,
const QClipboard_Mode mode = QClipboard::Clipboard)
Method void QClipboard::setMimeData(QMimeData *data, QClipboard::Mode mode)
voidsetPixmap(const QPixmap arg1,
const QClipboard_Mode mode = QClipboard::Clipboard)
Method void QClipboard::setPixmap(const QPixmap &, QClipboard::Mode mode)
voidsetText(string arg1,
const QClipboard_Mode mode = QClipboard::Clipboard)
Method void QClipboard::setText(const QString &, QClipboard::Mode mode)
[const]boolsupportsFindBufferMethod bool QClipboard::supportsFindBuffer()
[const]boolsupportsSelectionMethod bool QClipboard::supportsSelection()
[const]stringtext(const QClipboard_Mode mode = QClipboard::Clipboard)Method QString QClipboard::text(QClipboard::Mode mode)
[const]stringtext(string subtype,
const QClipboard_Mode mode = QClipboard::Clipboard)
Method QString QClipboard::text(QString &subtype, QClipboard::Mode mode)

Public static methods and constants

[static,const]QClipboard_ModeClipboardEnum constant QClipboard::Clipboard
[static,const]QClipboard_ModeFindBufferEnum constant QClipboard::FindBuffer
[static,const]QClipboard_ModeLastModeEnum constant QClipboard::LastMode
[static,const]QClipboard_ModeSelectionEnum constant QClipboard::Selection
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QClipboard::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QClipboard::trUtf8(const char *s, const char *c, int n)

Detailed description

Clipboard

Signature: [static,const] QClipboard_Mode Clipboard

Description: Enum constant QClipboard::Clipboard

Python specific notes:
The object exposes a readable attribute 'Clipboard'. This is the getter.

FindBuffer

Signature: [static,const] QClipboard_Mode FindBuffer

Description: Enum constant QClipboard::FindBuffer

Python specific notes:
The object exposes a readable attribute 'FindBuffer'. This is the getter.

LastMode

Signature: [static,const] QClipboard_Mode LastMode

Description: Enum constant QClipboard::LastMode

Python specific notes:
The object exposes a readable attribute 'LastMode'. This is the getter.

Selection

Signature: [static,const] QClipboard_Mode Selection

Description: Enum constant QClipboard::Selection

Python specific notes:
The object exposes a readable attribute 'Selection'. This is the getter.

_const_cast

Signature: [const] QClipboard ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

changed

Signature: [signal] void changed (const QClipboard_Mode mode)

Description: Signal declaration for QClipboard::changed(QClipboard::Mode mode)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'changed'. This is the getter.
The object exposes a writable attribute 'changed'. This is the setter.

clear

Signature: void clear (const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method void QClipboard::clear(QClipboard::Mode mode)

dataChanged

Signature: [signal] void dataChanged

Description: Signal declaration for QClipboard::dataChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'dataChanged'. This is the getter.
The object exposes a writable attribute 'dataChanged'. This is the setter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QClipboard::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

findBufferChanged

Signature: [signal] void findBufferChanged

Description: Signal declaration for QClipboard::findBufferChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'findBufferChanged'. This is the getter.
The object exposes a writable attribute 'findBufferChanged'. This is the setter.

image

Signature: [const] QImage image (const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method QImage QClipboard::image(QClipboard::Mode mode)

mimeData

Signature: [const] const QMimeData ptr mimeData (const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method const QMimeData *QClipboard::mimeData(QClipboard::Mode mode)

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QClipboard::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

ownsClipboard

Signature: [const] bool ownsClipboard

Description: Method bool QClipboard::ownsClipboard()

ownsFindBuffer

Signature: [const] bool ownsFindBuffer

Description: Method bool QClipboard::ownsFindBuffer()

ownsSelection

Signature: [const] bool ownsSelection

Description: Method bool QClipboard::ownsSelection()

pixmap

Signature: [const] QPixmap pixmap (const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method QPixmap QClipboard::pixmap(QClipboard::Mode mode)

selectionChanged

Signature: [signal] void selectionChanged

Description: Signal declaration for QClipboard::selectionChanged()

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'selectionChanged'. This is the getter.
The object exposes a writable attribute 'selectionChanged'. This is the setter.

setImage

Signature: void setImage (const QImage arg1, const QClipboard_Mode mode = QClipboard::Clipboard)

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

setMimeData

Signature: void setMimeData (QMimeData ptr data, const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method void QClipboard::setMimeData(QMimeData *data, QClipboard::Mode mode)

setPixmap

Signature: void setPixmap (const QPixmap arg1, const QClipboard_Mode mode = QClipboard::Clipboard)

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

setText

Signature: void setText (string arg1, const QClipboard_Mode mode = QClipboard::Clipboard)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

supportsFindBuffer

Signature: [const] bool supportsFindBuffer

Description: Method bool QClipboard::supportsFindBuffer()

supportsSelection

Signature: [const] bool supportsSelection

Description: Method bool QClipboard::supportsSelection()

text

(1) Signature: [const] string text (const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method QString QClipboard::text(QClipboard::Mode mode)

(2) Signature: [const] string text (string subtype, const QClipboard_Mode mode = QClipboard::Clipboard)

Description: Method QString QClipboard::text(QString &subtype, QClipboard::Mode mode)

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QClipboard::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QClipboard::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.