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.
const QVector< EnumDefinitionElement > &	elements () const
	Returns the individual elements of this enum.
EnumId	id () const
	A unique identifier for this enum definition.
bool	isFlag () const
	Returns true if this enum is used as a flag.
bool	isValid () const
	Returns whether this is a valid enum definition.
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()

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