GammaRay API Documentation  2.11.3
Public Member Functions | List of all members
GammaRay::EnumDefinition Class Reference

Target-independent representation of an enum or flag definition. More...

#include <enumdefinition.h>

Public Member Functions

 EnumDefinition (EnumId id, const QByteArray &name)
 Create a new definition for an enum named name and internal id id.
 
QVector< EnumDefinitionElementelements () const
 Returns the individual elements of this enum. More...
 
EnumId id () const
 A unique identifier for this enum definition. More...
 
bool isFlag () const
 Returns true if this enum is used as a flag.
 
bool isValid () const
 Returns whether this is a valid enum definition. More...
 
QByteArray name () const
 The name of the enum.
 
QByteArray valueToString (const EnumValue &value) const
 Converts the given enum value into a string representation.
 

Detailed Description

Target-independent representation of an enum or flag definition.

Member Function Documentation

◆ elements()

QVector<EnumDefinitionElement> GammaRay::EnumDefinition::elements ( ) const

Returns the individual elements of this enum.

That is, the key/value pairs of its definition.

◆ id()

EnumId GammaRay::EnumDefinition::id ( ) const

A unique identifier for this enum definition.

This is used to identify enums between the GammaRay client and server.

◆ isValid()

bool GammaRay::EnumDefinition::isValid ( ) const

Returns whether this is a valid enum definition.

This means it's a enum definition registered with the EnumRepository and there is at least one enum definition element present.


© 2010-2021 Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
GammaRay Qt-application inspection and manipulation tool
https://www.kdab.com/development-resources/qt-tools/gammaray/
Generated on Tue Dec 7 2021 02:34:36 for GammaRay API Documentation by doxygen 1.8.17