API reference - Class QSettings_Format

Notation used in Ruby API documentation

Description: This class represents the QSettings::Format enum

Class hierarchy: QSettings_Format » QSettings_QFlags_Format

Public constructors

new QSettings_Formatnew(unsigned int value)Creates the enum object from an integer

Public methods

[const]bool==(QSettings_Format other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const QSettings_Format other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QSettings_FormatdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

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

Detailed description

[const] bool ==(QSettings_Format other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new QSettings_Format CustomFormat1

Description: Enum constant QSettings::CustomFormat1

[static] new QSettings_Format CustomFormat10

Description: Enum constant QSettings::CustomFormat10

[static] new QSettings_Format CustomFormat11

Description: Enum constant QSettings::CustomFormat11

[static] new QSettings_Format CustomFormat12

Description: Enum constant QSettings::CustomFormat12

[static] new QSettings_Format CustomFormat13

Description: Enum constant QSettings::CustomFormat13

[static] new QSettings_Format CustomFormat14

Description: Enum constant QSettings::CustomFormat14

[static] new QSettings_Format CustomFormat15

Description: Enum constant QSettings::CustomFormat15

[static] new QSettings_Format CustomFormat16

Description: Enum constant QSettings::CustomFormat16

[static] new QSettings_Format CustomFormat2

Description: Enum constant QSettings::CustomFormat2

[static] new QSettings_Format CustomFormat3

Description: Enum constant QSettings::CustomFormat3

[static] new QSettings_Format CustomFormat4

Description: Enum constant QSettings::CustomFormat4

[static] new QSettings_Format CustomFormat5

Description: Enum constant QSettings::CustomFormat5

[static] new QSettings_Format CustomFormat6

Description: Enum constant QSettings::CustomFormat6

[static] new QSettings_Format CustomFormat7

Description: Enum constant QSettings::CustomFormat7

[static] new QSettings_Format CustomFormat8

Description: Enum constant QSettings::CustomFormat8

[static] new QSettings_Format CustomFormat9

Description: Enum constant QSettings::CustomFormat9

[static] new QSettings_Format IniFormat

Description: Enum constant QSettings::IniFormat

[static] new QSettings_Format InvalidFormat

Description: Enum constant QSettings::InvalidFormat

[static] new QSettings_Format NativeFormat

Description: Enum constant QSettings::NativeFormat

[const] void assign(const QSettings_Format other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

void destroy

Description: Explicitly destroy the object

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

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

[const] QSettings_Format dup

Description: Creates a copy of self

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

[static] new QSettings_Format new(unsigned int value)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string