API reference - Class QSettings::Format

Notation used in Ruby API documentation

Description: This class represents the QSettings::Format enum

This class is equivalent to the class QSettings_Format

Public constructors

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

Public methods

[const]bool!=(const QSettings_Format other)Compares two enums for inequality
[const]bool<(const QSettings_Format other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const QSettings_Format other)Compares two enums
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 QSettings_Format other)Assigns another object to self
[const]new QSettings_Format ptrdupCreates a copy of self
[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]QSettings_QFlags_Format|(const QSettings_Format other)Creates a flag set by combining the two flags
[const]QSettings_QFlags_Format|(const QSettings_QFlags_Format other)Combines the flag and the flag set

Public static methods and constants

[static,const]QSettings_FormatCustomFormat1Enum constant QSettings::CustomFormat1
[static,const]QSettings_FormatCustomFormat10Enum constant QSettings::CustomFormat10
[static,const]QSettings_FormatCustomFormat11Enum constant QSettings::CustomFormat11
[static,const]QSettings_FormatCustomFormat12Enum constant QSettings::CustomFormat12
[static,const]QSettings_FormatCustomFormat13Enum constant QSettings::CustomFormat13
[static,const]QSettings_FormatCustomFormat14Enum constant QSettings::CustomFormat14
[static,const]QSettings_FormatCustomFormat15Enum constant QSettings::CustomFormat15
[static,const]QSettings_FormatCustomFormat16Enum constant QSettings::CustomFormat16
[static,const]QSettings_FormatCustomFormat2Enum constant QSettings::CustomFormat2
[static,const]QSettings_FormatCustomFormat3Enum constant QSettings::CustomFormat3
[static,const]QSettings_FormatCustomFormat4Enum constant QSettings::CustomFormat4
[static,const]QSettings_FormatCustomFormat5Enum constant QSettings::CustomFormat5
[static,const]QSettings_FormatCustomFormat6Enum constant QSettings::CustomFormat6
[static,const]QSettings_FormatCustomFormat7Enum constant QSettings::CustomFormat7
[static,const]QSettings_FormatCustomFormat8Enum constant QSettings::CustomFormat8
[static,const]QSettings_FormatCustomFormat9Enum constant QSettings::CustomFormat9
[static,const]QSettings_FormatIniFormatEnum constant QSettings::IniFormat
[static,const]QSettings_FormatInvalidFormatEnum constant QSettings::InvalidFormat
[static,const]QSettings_FormatNativeFormatEnum constant QSettings::NativeFormat

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 QSettings_Format other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const QSettings_Format other)

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

==

Signature: [const] bool == (const QSettings_Format other)

Description: Compares two enums

CustomFormat1

Signature: [static,const] QSettings_Format CustomFormat1

Description: Enum constant QSettings::CustomFormat1

CustomFormat10

Signature: [static,const] QSettings_Format CustomFormat10

Description: Enum constant QSettings::CustomFormat10

CustomFormat11

Signature: [static,const] QSettings_Format CustomFormat11

Description: Enum constant QSettings::CustomFormat11

CustomFormat12

Signature: [static,const] QSettings_Format CustomFormat12

Description: Enum constant QSettings::CustomFormat12

CustomFormat13

Signature: [static,const] QSettings_Format CustomFormat13

Description: Enum constant QSettings::CustomFormat13

CustomFormat14

Signature: [static,const] QSettings_Format CustomFormat14

Description: Enum constant QSettings::CustomFormat14

CustomFormat15

Signature: [static,const] QSettings_Format CustomFormat15

Description: Enum constant QSettings::CustomFormat15

CustomFormat16

Signature: [static,const] QSettings_Format CustomFormat16

Description: Enum constant QSettings::CustomFormat16

CustomFormat2

Signature: [static,const] QSettings_Format CustomFormat2

Description: Enum constant QSettings::CustomFormat2

CustomFormat3

Signature: [static,const] QSettings_Format CustomFormat3

Description: Enum constant QSettings::CustomFormat3

CustomFormat4

Signature: [static,const] QSettings_Format CustomFormat4

Description: Enum constant QSettings::CustomFormat4

CustomFormat5

Signature: [static,const] QSettings_Format CustomFormat5

Description: Enum constant QSettings::CustomFormat5

CustomFormat6

Signature: [static,const] QSettings_Format CustomFormat6

Description: Enum constant QSettings::CustomFormat6

CustomFormat7

Signature: [static,const] QSettings_Format CustomFormat7

Description: Enum constant QSettings::CustomFormat7

CustomFormat8

Signature: [static,const] QSettings_Format CustomFormat8

Description: Enum constant QSettings::CustomFormat8

CustomFormat9

Signature: [static,const] QSettings_Format CustomFormat9

Description: Enum constant QSettings::CustomFormat9

IniFormat

Signature: [static,const] QSettings_Format IniFormat

Description: Enum constant QSettings::IniFormat

InvalidFormat

Signature: [static,const] QSettings_Format InvalidFormat

Description: Enum constant QSettings::InvalidFormat

NativeFormat

Signature: [static,const] QSettings_Format NativeFormat

Description: Enum constant QSettings::NativeFormat

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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

dup

Signature: [const] new QSettings_Format ptr dup

Description: Creates a copy of self

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

new

Signature: [static] new QSettings_Format ptr new (int i)

Description: Creates an enum from an integer value

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

Signature: [static] new QSettings_Format 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

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)'

|

Signature: [const] QSettings_QFlags_Format | (const QSettings_Format other)

Description: Creates a flag set by combining the two flags

Signature: [const] QSettings_QFlags_Format | (const QSettings_QFlags_Format other)

Description: Combines the flag and the flag set