API reference - Class QSslKey

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QSslKey

Public constructors

new QSslKeynewConstructor QSslKey::QSslKey()
new QSslKeynew(bytes encoded,
const QSsl_KeyAlgorithm algorithm,
const QSsl_EncodingFormat format = QSsl::Pem,
const QSsl_KeyType type = QSsl::PrivateKey,
bytes passPhrase = QByteArray())
Constructor QSslKey::QSslKey(const QByteArray &encoded, QSsl::KeyAlgorithm algorithm, QSsl::EncodingFormat format, QSsl::KeyType type, const QByteArray &passPhrase)
new QSslKeynew(QIODevice ptr device,
const QSsl_KeyAlgorithm algorithm,
const QSsl_EncodingFormat format = QSsl::Pem,
const QSsl_KeyType type = QSsl::PrivateKey,
bytes passPhrase = QByteArray())
Constructor QSslKey::QSslKey(QIODevice *device, QSsl::KeyAlgorithm algorithm, QSsl::EncodingFormat format, QSsl::KeyType type, const QByteArray &passPhrase)
new QSslKeynew(void * handle,
const QSsl_KeyType type = QSsl::PrivateKey)
Constructor QSslKey::QSslKey(Qt::HANDLE handle, QSsl::KeyType type)
new QSslKeynew(const QSslKey other)Constructor QSslKey::QSslKey(const QSslKey &other)

Public methods

[const]bool!=(const QSslKey key)Method bool QSslKey::operator!=(const QSslKey &key)
[const]bool==(const QSslKey key)Method bool QSslKey::operator==(const QSslKey &key)
void_assign(const QSslKey other)Assigns another object to self
[const]QSslKey ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[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.
[const]QSsl_KeyAlgorithmalgorithmMethod QSsl::KeyAlgorithm QSslKey::algorithm()
QSslKeyassign(const QSslKey other)Method QSslKey &QSslKey::operator=(const QSslKey &other)
voidclearMethod void QSslKey::clear()
[const]new QSslKey ptrdupCreates a copy of self
[const]void *handleMethod Qt::HANDLE QSslKey::handle()
[const]boolisNull?Method bool QSslKey::isNull()
[const]intlengthMethod int QSslKey::length()
voidswap(QSslKey other)Method void QSslKey::swap(QSslKey &other)
[const]bytestoDer(bytes passPhrase = QByteArray())Method QByteArray QSslKey::toDer(const QByteArray &passPhrase)
[const]bytestoPem(bytes passPhrase = QByteArray())Method QByteArray QSslKey::toPem(const QByteArray &passPhrase)
[const]QSsl_KeyTypetypeMethod QSsl::KeyType QSslKey::type()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QSslKey key)

Description: Method bool QSslKey::operator!=(const QSslKey &key)

==

Signature: [const] bool == (const QSslKey key)

Description: Method bool QSslKey::operator==(const QSslKey &key)

_assign

Signature: void _assign (const QSslKey other)

Description: Assigns another object to self

_const_cast

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

algorithm

Signature: [const] QSsl_KeyAlgorithm algorithm

Description: Method QSsl::KeyAlgorithm QSslKey::algorithm()

assign

Signature: QSslKey assign (const QSslKey other)

Description: Method QSslKey &QSslKey::operator=(const QSslKey &other)

clear

Signature: void clear

Description: Method void QSslKey::clear()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QSslKey ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

handle

Signature: [const] void * handle

Description: Method Qt::HANDLE QSslKey::handle()

isNull?

Signature: [const] bool isNull?

Description: Method bool QSslKey::isNull()

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

length

Signature: [const] int length

Description: Method int QSslKey::length()

new

(1) Signature: [static] new QSslKey new

Description: Constructor QSslKey::QSslKey()

This method creates an object of class QSslKey.

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

(2) Signature: [static] new QSslKey new (bytes encoded, const QSsl_KeyAlgorithm algorithm, const QSsl_EncodingFormat format = QSsl::Pem, const QSsl_KeyType type = QSsl::PrivateKey, bytes passPhrase = QByteArray())

Description: Constructor QSslKey::QSslKey(const QByteArray &encoded, QSsl::KeyAlgorithm algorithm, QSsl::EncodingFormat format, QSsl::KeyType type, const QByteArray &passPhrase)

This method creates an object of class QSslKey.

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

(3) Signature: [static] new QSslKey new (QIODevice ptr device, const QSsl_KeyAlgorithm algorithm, const QSsl_EncodingFormat format = QSsl::Pem, const QSsl_KeyType type = QSsl::PrivateKey, bytes passPhrase = QByteArray())

Description: Constructor QSslKey::QSslKey(QIODevice *device, QSsl::KeyAlgorithm algorithm, QSsl::EncodingFormat format, QSsl::KeyType type, const QByteArray &passPhrase)

This method creates an object of class QSslKey.

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

(4) Signature: [static] new QSslKey new (void * handle, const QSsl_KeyType type = QSsl::PrivateKey)

Description: Constructor QSslKey::QSslKey(Qt::HANDLE handle, QSsl::KeyType type)

This method creates an object of class QSslKey.

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

(5) Signature: [static] new QSslKey new (const QSslKey other)

Description: Constructor QSslKey::QSslKey(const QSslKey &other)

This method creates an object of class QSslKey.

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

swap

Signature: void swap (QSslKey other)

Description: Method void QSslKey::swap(QSslKey &other)

toDer

Signature: [const] bytes toDer (bytes passPhrase = QByteArray())

Description: Method QByteArray QSslKey::toDer(const QByteArray &passPhrase)

toPem

Signature: [const] bytes toPem (bytes passPhrase = QByteArray())

Description: Method QByteArray QSslKey::toPem(const QByteArray &passPhrase)

type

Signature: [const] QSsl_KeyType type

Description: Method QSsl::KeyType QSslKey::type()