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

API reference - Class QStorageInfo

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QStorageInfo

Public constructors

new QStorageInfonewConstructor QStorageInfo::QStorageInfo()
new QStorageInfonew(string path)Constructor QStorageInfo::QStorageInfo(const QString &path)
new QStorageInfonew(const QDir dir)Constructor QStorageInfo::QStorageInfo(const QDir &dir)
new QStorageInfonew(const QStorageInfo other)Constructor QStorageInfo::QStorageInfo(const QStorageInfo &other)

Public methods

[const]bool!=(const QStorageInfo second)Operator bool ::operator!=(const QStorageInfo &first, const QStorageInfo &second)
[const]bool==(const QStorageInfo second)Operator bool ::operator==(const QStorageInfo &first, const QStorageInfo &second)
void_assign(const QStorageInfo other)Assigns another object to self
[const]QStorageInfo 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.
QStorageInfoassign(const QStorageInfo other)Method QStorageInfo &QStorageInfo::operator=(const QStorageInfo &other)
[const]intblockSizeMethod int QStorageInfo::blockSize()
[const]long longbytesAvailableMethod qint64 QStorageInfo::bytesAvailable()
[const]long longbytesFreeMethod qint64 QStorageInfo::bytesFree()
[const]long longbytesTotalMethod qint64 QStorageInfo::bytesTotal()
[const]bytesdeviceMethod QByteArray QStorageInfo::device()
[const]stringdisplayNameMethod QString QStorageInfo::displayName()
[const]new QStorageInfo ptrdupCreates a copy of self
[const]bytesfileSystemTypeMethod QByteArray QStorageInfo::fileSystemType()
[const]boolisReadOnly?Method bool QStorageInfo::isReadOnly()
[const]boolisReady?Method bool QStorageInfo::isReady()
[const]boolisRoot?Method bool QStorageInfo::isRoot()
[const]boolisValid?Method bool QStorageInfo::isValid()
[const]stringnameMethod QString QStorageInfo::name()
voidrefreshMethod void QStorageInfo::refresh()
[const]stringrootPathMethod QString QStorageInfo::rootPath()
voidsetPath(string path)Method void QStorageInfo::setPath(const QString &path)
[const]bytessubvolumeMethod QByteArray QStorageInfo::subvolume()
voidswap(QStorageInfo other)Method void QStorageInfo::swap(QStorageInfo &other)

Public static methods and constants

QStorageInfo[]mountedVolumesStatic method QList<QStorageInfo> QStorageInfo::mountedVolumes()
QStorageInforootStatic method QStorageInfo QStorageInfo::root()

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 QStorageInfo second)

Description: Operator bool ::operator!=(const QStorageInfo &first, const QStorageInfo &second)

This is the mapping of the global operator to the instance method.

==

Signature: [const] bool == (const QStorageInfo second)

Description: Operator bool ::operator==(const QStorageInfo &first, const QStorageInfo &second)

This is the mapping of the global operator to the instance method.

_assign

Signature: void _assign (const QStorageInfo other)

Description: Assigns another object to self

_const_cast

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

assign

Signature: QStorageInfo assign (const QStorageInfo other)

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

blockSize

Signature: [const] int blockSize

Description: Method int QStorageInfo::blockSize()

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Method qint64 QStorageInfo::bytesAvailable()

bytesFree

Signature: [const] long long bytesFree

Description: Method qint64 QStorageInfo::bytesFree()

bytesTotal

Signature: [const] long long bytesTotal

Description: Method qint64 QStorageInfo::bytesTotal()

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.

device

Signature: [const] bytes device

Description: Method QByteArray QStorageInfo::device()

displayName

Signature: [const] string displayName

Description: Method QString QStorageInfo::displayName()

dup

Signature: [const] new QStorageInfo ptr dup

Description: Creates a copy of self

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

fileSystemType

Signature: [const] bytes fileSystemType

Description: Method QByteArray QStorageInfo::fileSystemType()

isReadOnly?

Signature: [const] bool isReadOnly?

Description: Method bool QStorageInfo::isReadOnly()

isReady?

Signature: [const] bool isReady?

Description: Method bool QStorageInfo::isReady()

isRoot?

Signature: [const] bool isRoot?

Description: Method bool QStorageInfo::isRoot()

isValid?

Signature: [const] bool isValid?

Description: Method bool QStorageInfo::isValid()

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.

mountedVolumes

Signature: [static] QStorageInfo[] mountedVolumes

Description: Static method QList<QStorageInfo> QStorageInfo::mountedVolumes()

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

name

Signature: [const] string name

Description: Method QString QStorageInfo::name()

new

(1) Signature: [static] new QStorageInfo new

Description: Constructor QStorageInfo::QStorageInfo()

This method creates an object of class QStorageInfo.

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

(2) Signature: [static] new QStorageInfo new (string path)

Description: Constructor QStorageInfo::QStorageInfo(const QString &path)

This method creates an object of class QStorageInfo.

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

(3) Signature: [static] new QStorageInfo new (const QDir dir)

Description: Constructor QStorageInfo::QStorageInfo(const QDir &dir)

This method creates an object of class QStorageInfo.

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

(4) Signature: [static] new QStorageInfo new (const QStorageInfo other)

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

This method creates an object of class QStorageInfo.

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

refresh

Signature: void refresh

Description: Method void QStorageInfo::refresh()

root

Signature: [static] QStorageInfo root

Description: Static method QStorageInfo QStorageInfo::root()

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

rootPath

Signature: [const] string rootPath

Description: Method QString QStorageInfo::rootPath()

setPath

Signature: void setPath (string path)

Description: Method void QStorageInfo::setPath(const QString &path)

subvolume

Signature: [const] bytes subvolume

Description: Method QByteArray QStorageInfo::subvolume()

swap

Signature: void swap (QStorageInfo other)

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