API reference - Class QSharedMemory

AlreadyExists

Signature: [static,const] QSharedMemory_SharedMemoryError AlreadyExists

Description: Enum constant QSharedMemory::AlreadyExists

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

InvalidSize

Signature: [static,const] QSharedMemory_SharedMemoryError InvalidSize

Description: Enum constant QSharedMemory::InvalidSize

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

KeyError

Signature: [static,const] QSharedMemory_SharedMemoryError KeyError

Description: Enum constant QSharedMemory::KeyError

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

LockError

Signature: [static,const] QSharedMemory_SharedMemoryError LockError

Description: Enum constant QSharedMemory::LockError

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

NoError

Signature: [static,const] QSharedMemory_SharedMemoryError NoError

Description: Enum constant QSharedMemory::NoError

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

NotFound

Signature: [static,const] QSharedMemory_SharedMemoryError NotFound

Description: Enum constant QSharedMemory::NotFound

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

OutOfResources

Signature: [static,const] QSharedMemory_SharedMemoryError OutOfResources

Description: Enum constant QSharedMemory::OutOfResources

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

PermissionDenied

Signature: [static,const] QSharedMemory_SharedMemoryError PermissionDenied

Description: Enum constant QSharedMemory::PermissionDenied

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

ReadOnly

Signature: [static,const] QSharedMemory_AccessMode ReadOnly

Description: Enum constant QSharedMemory::ReadOnly

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

ReadWrite

Signature: [static,const] QSharedMemory_AccessMode ReadWrite

Description: Enum constant QSharedMemory::ReadWrite

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

UnknownError

Signature: [static,const] QSharedMemory_SharedMemoryError UnknownError

Description: Enum constant QSharedMemory::UnknownError

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

_const_cast

Signature: [const] QSharedMemory 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.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_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.

attach

Signature: bool attach (const QSharedMemory_AccessMode mode = QSharedMemory::ReadWrite)

Description: Method bool QSharedMemory::attach(QSharedMemory::AccessMode mode)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QSharedMemory::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

constData

Signature: [const] void * constData

Description: Method const void *QSharedMemory::constData()

create

Signature: bool create (int size, const QSharedMemory_AccessMode mode = QSharedMemory::ReadWrite)

Description: Method bool QSharedMemory::create(int size, QSharedMemory::AccessMode mode)

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QSharedMemory::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

data

(1) Signature: void * data

Description: Method void *QSharedMemory::data()

(2) Signature: [const] void * data

Description: Method const void *QSharedMemory::data()

destroyed

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

Description: Signal declaration for QSharedMemory::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.

detach

Signature: bool detach

Description: Method bool QSharedMemory::detach()

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSharedMemory::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSharedMemory::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSharedMemory::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

error

Signature: [const] QSharedMemory_SharedMemoryError error

Description: Method QSharedMemory::SharedMemoryError QSharedMemory::error()

errorString

Signature: [const] string errorString

Description: Method QString QSharedMemory::errorString()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSharedMemory::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QSharedMemory::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isAttached?

Signature: [const] bool isAttached?

Description: Method bool QSharedMemory::isAttached()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSharedMemory::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

key

Signature: [const] string key

Description: Method QString QSharedMemory::key()

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

key=

Signature: void key= (string key)

Description: Method void QSharedMemory::setKey(const QString &key)

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

lock

Signature: bool lock

Description: Method bool QSharedMemory::lock()

nativeKey

Signature: [const] string nativeKey

Description: Method QString QSharedMemory::nativeKey()

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

nativeKey=

Signature: void nativeKey= (string key)

Description: Method void QSharedMemory::setNativeKey(const QString &key)

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

new

(1) Signature: [static] new QSharedMemory new (QObject ptr parent = nullptr)

Description: Constructor QSharedMemory::QSharedMemory(QObject *parent)

This method creates an object of class QSharedMemory.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSharedMemory new (string key, QObject ptr parent = nullptr)

Description: Constructor QSharedMemory::QSharedMemory(const QString &key, QObject *parent)

This method creates an object of class QSharedMemory.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSharedMemory::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.

qt_create

Signature: bool qt_create (int size, const QSharedMemory_AccessMode mode = QSharedMemory::ReadWrite)

Description: Method bool QSharedMemory::create(int size, QSharedMemory::AccessMode mode)

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSharedMemory::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSharedMemory::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSharedMemory::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setKey

Signature: void setKey (string key)

Description: Method void QSharedMemory::setKey(const QString &key)

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

setNativeKey

Signature: void setNativeKey (string key)

Description: Method void QSharedMemory::setNativeKey(const QString &key)

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

size

Signature: [const] int size

Description: Method int QSharedMemory::size()

Python specific notes:
This method is also available as 'len(object)'.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QSharedMemory::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

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

Description: Static method QString QSharedMemory::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 QSharedMemory::trUtf8(const char *s, const char *c, int n)

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

unlock

Signature: bool unlock

Description: Method bool QSharedMemory::unlock()