API reference - Class QVariant::Type

Notation used in Ruby API documentation

Description: This class represents the QVariant::Type enum

This class is equivalent to the class QVariant_Type

Public constructors

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

Public methods

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

Public static methods and constants

[static,const]QVariant_TypeBitArrayEnum constant QVariant::BitArray
[static,const]QVariant_TypeBitmapEnum constant QVariant::Bitmap
[static,const]QVariant_TypeBoolEnum constant QVariant::Bool
[static,const]QVariant_TypeBrushEnum constant QVariant::Brush
[static,const]QVariant_TypeByteArrayEnum constant QVariant::ByteArray
[static,const]QVariant_TypeCharEnum constant QVariant::Char
[static,const]QVariant_TypeColorEnum constant QVariant::Color
[static,const]QVariant_TypeCursorEnum constant QVariant::Cursor
[static,const]QVariant_TypeDateEnum constant QVariant::Date
[static,const]QVariant_TypeDateTimeEnum constant QVariant::DateTime
[static,const]QVariant_TypeDoubleEnum constant QVariant::Double
[static,const]QVariant_TypeFontEnum constant QVariant::Font
[static,const]QVariant_TypeHashEnum constant QVariant::Hash
[static,const]QVariant_TypeIconEnum constant QVariant::Icon
[static,const]QVariant_TypeImageEnum constant QVariant::Image
[static,const]QVariant_TypeIntEnum constant QVariant::Int
[static,const]QVariant_TypeInvalidEnum constant QVariant::Invalid
[static,const]QVariant_TypeKeySequenceEnum constant QVariant::KeySequence
[static,const]QVariant_TypeLastCoreTypeEnum constant QVariant::LastCoreType
[static,const]QVariant_TypeLastGuiTypeEnum constant QVariant::LastGuiType
[static,const]QVariant_TypeLastTypeEnum constant QVariant::LastType
[static,const]QVariant_TypeLineEnum constant QVariant::Line
[static,const]QVariant_TypeLineFEnum constant QVariant::LineF
[static,const]QVariant_TypeListEnum constant QVariant::List
[static,const]QVariant_TypeLocaleEnum constant QVariant::Locale
[static,const]QVariant_TypeLongLongEnum constant QVariant::LongLong
[static,const]QVariant_TypeMapEnum constant QVariant::Map
[static,const]QVariant_TypeMatrixEnum constant QVariant::Matrix
[static,const]QVariant_TypeMatrix4x4Enum constant QVariant::Matrix4x4
[static,const]QVariant_TypePaletteEnum constant QVariant::Palette
[static,const]QVariant_TypePenEnum constant QVariant::Pen
[static,const]QVariant_TypePixmapEnum constant QVariant::Pixmap
[static,const]QVariant_TypePointEnum constant QVariant::Point
[static,const]QVariant_TypePointFEnum constant QVariant::PointF
[static,const]QVariant_TypePolygonEnum constant QVariant::Polygon
[static,const]QVariant_TypeQuaternionEnum constant QVariant::Quaternion
[static,const]QVariant_TypeRectEnum constant QVariant::Rect
[static,const]QVariant_TypeRectFEnum constant QVariant::RectF
[static,const]QVariant_TypeRegExpEnum constant QVariant::RegExp
[static,const]QVariant_TypeRegionEnum constant QVariant::Region
[static,const]QVariant_TypeSizeEnum constant QVariant::Size
[static,const]QVariant_TypeSizeFEnum constant QVariant::SizeF
[static,const]QVariant_TypeSizePolicyEnum constant QVariant::SizePolicy
[static,const]QVariant_TypeStringEnum constant QVariant::String
[static,const]QVariant_TypeStringListEnum constant QVariant::StringList
[static,const]QVariant_TypeTextFormatEnum constant QVariant::TextFormat
[static,const]QVariant_TypeTextLengthEnum constant QVariant::TextLength
[static,const]QVariant_TypeTimeEnum constant QVariant::Time
[static,const]QVariant_TypeTransformEnum constant QVariant::Transform
[static,const]QVariant_TypeUIntEnum constant QVariant::UInt
[static,const]QVariant_TypeULongLongEnum constant QVariant::ULongLong
[static,const]QVariant_TypeUrlEnum constant QVariant::Url
[static,const]QVariant_TypeUserTypeEnum constant QVariant::UserType
[static,const]QVariant_TypeVector2DEnum constant QVariant::Vector2D
[static,const]QVariant_TypeVector3DEnum constant QVariant::Vector3D
[static,const]QVariant_TypeVector4DEnum constant QVariant::Vector4D

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

Description: Compares two enums for inequality

<

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

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

==

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

Description: Compares two enums

BitArray

Signature: [static,const] QVariant_Type BitArray

Description: Enum constant QVariant::BitArray

Bitmap

Signature: [static,const] QVariant_Type Bitmap

Description: Enum constant QVariant::Bitmap

Bool

Signature: [static,const] QVariant_Type Bool

Description: Enum constant QVariant::Bool

Brush

Signature: [static,const] QVariant_Type Brush

Description: Enum constant QVariant::Brush

ByteArray

Signature: [static,const] QVariant_Type ByteArray

Description: Enum constant QVariant::ByteArray

Char

Signature: [static,const] QVariant_Type Char

Description: Enum constant QVariant::Char

Color

Signature: [static,const] QVariant_Type Color

Description: Enum constant QVariant::Color

Cursor

Signature: [static,const] QVariant_Type Cursor

Description: Enum constant QVariant::Cursor

Date

Signature: [static,const] QVariant_Type Date

Description: Enum constant QVariant::Date

DateTime

Signature: [static,const] QVariant_Type DateTime

Description: Enum constant QVariant::DateTime

Double

Signature: [static,const] QVariant_Type Double

Description: Enum constant QVariant::Double

Font

Signature: [static,const] QVariant_Type Font

Description: Enum constant QVariant::Font

Hash

Signature: [static,const] QVariant_Type Hash

Description: Enum constant QVariant::Hash

Icon

Signature: [static,const] QVariant_Type Icon

Description: Enum constant QVariant::Icon

Image

Signature: [static,const] QVariant_Type Image

Description: Enum constant QVariant::Image

Int

Signature: [static,const] QVariant_Type Int

Description: Enum constant QVariant::Int

Invalid

Signature: [static,const] QVariant_Type Invalid

Description: Enum constant QVariant::Invalid

KeySequence

Signature: [static,const] QVariant_Type KeySequence

Description: Enum constant QVariant::KeySequence

LastCoreType

Signature: [static,const] QVariant_Type LastCoreType

Description: Enum constant QVariant::LastCoreType

LastGuiType

Signature: [static,const] QVariant_Type LastGuiType

Description: Enum constant QVariant::LastGuiType

LastType

Signature: [static,const] QVariant_Type LastType

Description: Enum constant QVariant::LastType

Line

Signature: [static,const] QVariant_Type Line

Description: Enum constant QVariant::Line

LineF

Signature: [static,const] QVariant_Type LineF

Description: Enum constant QVariant::LineF

List

Signature: [static,const] QVariant_Type List

Description: Enum constant QVariant::List

Locale

Signature: [static,const] QVariant_Type Locale

Description: Enum constant QVariant::Locale

LongLong

Signature: [static,const] QVariant_Type LongLong

Description: Enum constant QVariant::LongLong

Map

Signature: [static,const] QVariant_Type Map

Description: Enum constant QVariant::Map

Matrix

Signature: [static,const] QVariant_Type Matrix

Description: Enum constant QVariant::Matrix

Matrix4x4

Signature: [static,const] QVariant_Type Matrix4x4

Description: Enum constant QVariant::Matrix4x4

Palette

Signature: [static,const] QVariant_Type Palette

Description: Enum constant QVariant::Palette

Pen

Signature: [static,const] QVariant_Type Pen

Description: Enum constant QVariant::Pen

Pixmap

Signature: [static,const] QVariant_Type Pixmap

Description: Enum constant QVariant::Pixmap

Point

Signature: [static,const] QVariant_Type Point

Description: Enum constant QVariant::Point

PointF

Signature: [static,const] QVariant_Type PointF

Description: Enum constant QVariant::PointF

Polygon

Signature: [static,const] QVariant_Type Polygon

Description: Enum constant QVariant::Polygon

Quaternion

Signature: [static,const] QVariant_Type Quaternion

Description: Enum constant QVariant::Quaternion

Rect

Signature: [static,const] QVariant_Type Rect

Description: Enum constant QVariant::Rect

RectF

Signature: [static,const] QVariant_Type RectF

Description: Enum constant QVariant::RectF

RegExp

Signature: [static,const] QVariant_Type RegExp

Description: Enum constant QVariant::RegExp

Region

Signature: [static,const] QVariant_Type Region

Description: Enum constant QVariant::Region

Size

Signature: [static,const] QVariant_Type Size

Description: Enum constant QVariant::Size

SizeF

Signature: [static,const] QVariant_Type SizeF

Description: Enum constant QVariant::SizeF

SizePolicy

Signature: [static,const] QVariant_Type SizePolicy

Description: Enum constant QVariant::SizePolicy

String

Signature: [static,const] QVariant_Type String

Description: Enum constant QVariant::String

StringList

Signature: [static,const] QVariant_Type StringList

Description: Enum constant QVariant::StringList

TextFormat

Signature: [static,const] QVariant_Type TextFormat

Description: Enum constant QVariant::TextFormat

TextLength

Signature: [static,const] QVariant_Type TextLength

Description: Enum constant QVariant::TextLength

Time

Signature: [static,const] QVariant_Type Time

Description: Enum constant QVariant::Time

Transform

Signature: [static,const] QVariant_Type Transform

Description: Enum constant QVariant::Transform

UInt

Signature: [static,const] QVariant_Type UInt

Description: Enum constant QVariant::UInt

ULongLong

Signature: [static,const] QVariant_Type ULongLong

Description: Enum constant QVariant::ULongLong

Url

Signature: [static,const] QVariant_Type Url

Description: Enum constant QVariant::Url

UserType

Signature: [static,const] QVariant_Type UserType

Description: Enum constant QVariant::UserType

Vector2D

Signature: [static,const] QVariant_Type Vector2D

Description: Enum constant QVariant::Vector2D

Vector3D

Signature: [static,const] QVariant_Type Vector3D

Description: Enum constant QVariant::Vector3D

Vector4D

Signature: [static,const] QVariant_Type Vector4D

Description: Enum constant QVariant::Vector4D

_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 QVariant_Type 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 QVariant_Type 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 QVariant_Type 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 QVariant_Type 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] QVariant_QFlags_Type | (const QVariant_Type other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set