API reference - Class QDir::Filter

Notation used in Ruby API documentation

Module: QtCore

Description: This class represents the QDir::Filter enum

This class is equivalent to the class QDir_Filter

Public constructors

new QDir_Filter ptrnew(int i)Creates an enum from an integer value
new QDir_Filter ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QDir_Filter other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QDir_Filter other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QDir_Filter other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QDir_Filter 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.
voidassign(const QDir_Filter other)Assigns another object to self
[const]new QDir_Filter ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QDir_QFlags_Filter|(const QDir_Filter other)Creates a flag set by combining the two flags
[const]QDir_QFlags_Filter|(const QDir_QFlags_Filter other)Combines the flag and the flag set

Public static methods and constants

[static,const]QDir_FilterAccessMaskEnum constant QDir::AccessMask
[static,const]QDir_FilterAllDirsEnum constant QDir::AllDirs
[static,const]QDir_FilterAllEntriesEnum constant QDir::AllEntries
[static,const]QDir_FilterCaseSensitiveEnum constant QDir::CaseSensitive
[static,const]QDir_FilterDirsEnum constant QDir::Dirs
[static,const]QDir_FilterDrivesEnum constant QDir::Drives
[static,const]QDir_FilterExecutableEnum constant QDir::Executable
[static,const]QDir_FilterFilesEnum constant QDir::Files
[static,const]QDir_FilterHiddenEnum constant QDir::Hidden
[static,const]QDir_FilterModifiedEnum constant QDir::Modified
[static,const]QDir_FilterNoDotEnum constant QDir::NoDot
[static,const]QDir_FilterNoDotAndDotDotEnum constant QDir::NoDotAndDotDot
[static,const]QDir_FilterNoDotDotEnum constant QDir::NoDotDot
[static,const]QDir_FilterNoFilterEnum constant QDir::NoFilter
[static,const]QDir_FilterNoSymLinksEnum constant QDir::NoSymLinks
[static,const]QDir_FilterPermissionMaskEnum constant QDir::PermissionMask
[static,const]QDir_FilterReadableEnum constant QDir::Readable
[static,const]QDir_FilterSystemEnum constant QDir::System
[static,const]QDir_FilterTypeMaskEnum constant QDir::TypeMask
[static,const]QDir_FilterWritableEnum constant QDir::Writable

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

!=

(1) Signature: [const] bool != (const QDir_Filter other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QDir_Filter other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QDir_Filter other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

AccessMask

Signature: [static,const] QDir_Filter AccessMask

Description: Enum constant QDir::AccessMask

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

AllDirs

Signature: [static,const] QDir_Filter AllDirs

Description: Enum constant QDir::AllDirs

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

AllEntries

Signature: [static,const] QDir_Filter AllEntries

Description: Enum constant QDir::AllEntries

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

CaseSensitive

Signature: [static,const] QDir_Filter CaseSensitive

Description: Enum constant QDir::CaseSensitive

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

Dirs

Signature: [static,const] QDir_Filter Dirs

Description: Enum constant QDir::Dirs

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

Drives

Signature: [static,const] QDir_Filter Drives

Description: Enum constant QDir::Drives

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

Executable

Signature: [static,const] QDir_Filter Executable

Description: Enum constant QDir::Executable

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

Files

Signature: [static,const] QDir_Filter Files

Description: Enum constant QDir::Files

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

Hidden

Signature: [static,const] QDir_Filter Hidden

Description: Enum constant QDir::Hidden

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

Modified

Signature: [static,const] QDir_Filter Modified

Description: Enum constant QDir::Modified

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

NoDot

Signature: [static,const] QDir_Filter NoDot

Description: Enum constant QDir::NoDot

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

NoDotAndDotDot

Signature: [static,const] QDir_Filter NoDotAndDotDot

Description: Enum constant QDir::NoDotAndDotDot

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

NoDotDot

Signature: [static,const] QDir_Filter NoDotDot

Description: Enum constant QDir::NoDotDot

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

NoFilter

Signature: [static,const] QDir_Filter NoFilter

Description: Enum constant QDir::NoFilter

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

NoSymLinks

Signature: [static,const] QDir_Filter NoSymLinks

Description: Enum constant QDir::NoSymLinks

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

PermissionMask

Signature: [static,const] QDir_Filter PermissionMask

Description: Enum constant QDir::PermissionMask

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

Readable

Signature: [static,const] QDir_Filter Readable

Description: Enum constant QDir::Readable

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

System

Signature: [static,const] QDir_Filter System

Description: Enum constant QDir::System

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

TypeMask

Signature: [static,const] QDir_Filter TypeMask

Description: Enum constant QDir::TypeMask

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

Writable

Signature: [static,const] QDir_Filter Writable

Description: Enum constant QDir::Writable

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

_const_cast

Signature: [const] QDir_Filter 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: void assign (const QDir_Filter other)

Description: Assigns another object to self

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 QDir_Filter ptr dup

Description: Creates a copy of self

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

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.

new

(1) Signature: [static] new QDir_Filter ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new QDir_Filter ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

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

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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

|

(1) Signature: [const] QDir_QFlags_Filter | (const QDir_Filter other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QDir_QFlags_Filter | (const QDir_QFlags_Filter other)

Description: Combines the flag and the flag set