QMetaEnum

Synopsis

Functions

• def isFlag ()
• def isValid ()
• def key (index)
• def keyCount ()
• def keyToValue (key)
• def keysToValue (keys)
• def name ()
• def scope ()
• def value (index)
• def valueToKey (value)
• def valueToKeys (value)

Detailed Description

The PySide.QtCore.QMetaEnum class provides meta-data about an enumerator.

Use PySide.QtCore.QMetaEnum.name() for the enumerator’s name. The enumerator’s keys (names of each enumerated item) are returned by PySide.QtCore.QMetaEnum.key() ; use PySide.QtCore.QMetaEnum.keyCount() to find the number of keys. PySide.QtCore.QMetaEnum.isFlag() returns whether the enumerator is meant to be used as a flag, meaning that its values can be combined using the OR operator.

The conversion functions PySide.QtCore.QMetaEnum.keyToValue() , PySide.QtCore.QMetaEnum.valueToKey() , PySide.QtCore.QMetaEnum.keysToValue() , and PySide.QtCore.QMetaEnum.valueToKeys() allow conversion between the integer representation of an enumeration or set value and its literal representation. The PySide.QtCore.QMetaEnum.scope() function returns the class scope this enumerator was declared in.

See also

PySide.QtCore.QMetaObject PySide.QtCore.QMetaMethod PySide.QtCore.QMetaProperty

class PySide.QtCore.QMetaEnum

class PySide.QtCore.QMetaEnum(QMetaEnum)

Parameters:QMetaEnum – PySide.QtCore.QMetaEnum

PySide.QtCore.QMetaEnum.isFlag()

Return type:PySide.QtCore.bool

Returns true if this enumerator is used as a flag; otherwise returns false.

When used as flags, enumerators can be combined using the OR operator.

See also

PySide.QtCore.QMetaEnum.keysToValue() PySide.QtCore.QMetaEnum.valueToKeys()

PySide.QtCore.QMetaEnum.isValid()

Return type:PySide.QtCore.bool

Returns true if this enum is valid (has a name); otherwise returns false.

See also

PySide.QtCore.QMetaEnum.name()

PySide.QtCore.QMetaEnum.key(index)

Parameters:index – PySide.QtCore.int Return type:str

Returns the key with the given index , or 0 if no such key exists.

See also

PySide.QtCore.QMetaEnum.keyCount() PySide.QtCore.QMetaEnum.value() PySide.QtCore.QMetaEnum.valueToKey()

PySide.QtCore.QMetaEnum.keyCount()

Return type:PySide.QtCore.int

Returns the number of keys.

See also

PySide.QtCore.QMetaEnum.key()

PySide.QtCore.QMetaEnum.keyToValue(key)

Parameters:key – str Return type:PySide.QtCore.int

Returns the integer value of the given enumeration key , or -1 if key is not defined.

For flag types, use PySide.QtCore.QMetaEnum.keysToValue() .

See also

PySide.QtCore.QMetaEnum.valueToKey() PySide.QtCore.QMetaEnum.isFlag() PySide.QtCore.QMetaEnum.keysToValue()

PySide.QtCore.QMetaEnum.keysToValue(keys)

Parameters:keys – str Return type:PySide.QtCore.int

Returns the value derived from combining together the values of the keys using the OR operator, or -1 if keys is not defined. Note that the strings in keys must be ‘|’-separated.

See also

PySide.QtCore.QMetaEnum.isFlag() PySide.QtCore.QMetaEnum.valueToKey() PySide.QtCore.QMetaEnum.valueToKeys()

PySide.QtCore.QMetaEnum.name()

Return type:str

Returns the name of the enumerator (without the scope).

For example, the Qt.AlignmentFlag enumeration has AlignmentFlag as the name and Qt as the scope.

See also

PySide.QtCore.QMetaEnum.isValid() PySide.QtCore.QMetaEnum.scope()

PySide.QtCore.QMetaEnum.scope()

Return type:str

Returns the scope this enumerator was declared in.

For example, the Qt.AlignmentFlag enumeration has Qt as the scope and AlignmentFlag as the name.

See also

PySide.QtCore.QMetaEnum.name()

PySide.QtCore.QMetaEnum.value(index)

Parameters:index – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the value with the given index ; or returns -1 if there is no such value.

See also

PySide.QtCore.QMetaEnum.keyCount() PySide.QtCore.QMetaEnum.key() PySide.QtCore.QMetaEnum.keyToValue()

PySide.QtCore.QMetaEnum.valueToKey(value)

Parameters:value – PySide.QtCore.int Return type:str

Returns the string that is used as the name of the given enumeration value , or 0 if value is not defined.

For flag types, use PySide.QtCore.QMetaEnum.valueToKeys() .

See also

PySide.QtCore.QMetaEnum.isFlag() PySide.QtCore.QMetaEnum.valueToKeys()

PySide.QtCore.QMetaEnum.valueToKeys(value)

Parameters:value – PySide.QtCore.int Return type:PySide.QtCore.QByteArray

Returns a byte array of ‘|’-separated keys that represents the given value .

See also

PySide.QtCore.QMetaEnum.isFlag() PySide.QtCore.QMetaEnum.valueToKey() PySide.QtCore.QMetaEnum.keysToValue()