QMetaEnumBuilder Class Reference

The QMetaEnumBuilder class enables modifications to an enumerator definition on a meta object builder. More...

#include <qmetaobjectbuilder_p.h>

Public Functions
int	addKey (const QByteArray &name, int value)
	Adds a new key called name to this enumerator, associated with value. More...
int	index () const
	Returns the index of this enumerator within its QMetaObjectBuilder. More...
bool	isFlag () const
	Returns true if this enumerator is used as a flag; otherwise returns false. More...
QByteArray	key (int index) const
	Returns the key with the given index, or an empty QByteArray if no such key exists. More...
int	keyCount () const
	Returns the number of keys. More...
QByteArray	name () const
	Returns the name of the enumerator (without the scope). More...
	QMetaEnumBuilder ()
void	removeKey (int index)
	Removes the key at index from this enumerator. More...
void	setIsFlag (bool value)
	Sets this enumerator to be used as a flag if value is true. More...
int	value (int index) const
	Returns the value with the given index; or returns -1 if there is no such value. More...

Private Functions
QMetaEnumBuilderPrivate *	d_func () const
	QMetaEnumBuilder (const QMetaObjectBuilder *mobj, int index)

Properties
int	_index
const QMetaObjectBuilder *	_mobj

Friends
class	QMetaObjectBuilder

Detailed Description

The QMetaEnumBuilder class enables modifications to an enumerator definition on a meta object builder.

Warning

This function is not part of the public interface.

Definition at line 289 of file qmetaobjectbuilder_p.h.

Constructors and Destructors

QMetaEnumBuilder() [1/2]

QMetaEnumBuilder::QMetaEnumBuilder ( )

inline

Warning

This function is not part of the public interface.

Definition at line 292 of file qmetaobjectbuilder_p.h.

: _mobj(0), _index(0) {}

QMetaEnumBuilder() [2/2]

QMetaEnumBuilder::QMetaEnumBuilder ( const QMetaObjectBuilder *  mobj, int  index  )

inlineprivate

Definition at line 314 of file qmetaobjectbuilder_p.h.

        : _mobj(mobj), _index(index) {}

Functions

addKey()

int QMetaEnumBuilder::addKey	(	const QByteArray &	name,
		int	value
	)

Adds a new key called name to this enumerator, associated with value.

Returns the index of the new key.

See also

keyCount(), key(), value(), removeKey()

Definition at line 2595 of file qmetaobjectbuilder.cpp.

Referenced by QMetaObjectBuilder::addEnumerator().

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d) {
        int index = d->keys.size();
        d->keys += name;
        d->values += value;
        return index;
    } else {
        return -1;
    }
}

d_func()

QMetaEnumBuilderPrivate * QMetaEnumBuilder::d_func ( ) const

private

Definition at line 2484 of file qmetaobjectbuilder.cpp.

{
    if (_mobj && _index >= 0 && _index < _mobj->d->enumerators.size())
        return &(_mobj->d->enumerators[_index]);
    else
        return 0;
}

index()

int QMetaEnumBuilder::index ( ) const

inline

Returns the index of this enumerator within its QMetaObjectBuilder.

Definition at line 294 of file qmetaobjectbuilder_p.h.

{ return _index; }

isFlag()

bool QMetaEnumBuilder::isFlag

(

)

const

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

See also

setIsFlag()

Definition at line 2524 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d)
        return d->isFlag;
    else
        return false;
}

key()

QByteArray QMetaEnumBuilder::key

(

int

index

)

const

Returns the key with the given index, or an empty QByteArray if no such key exists.

See also

keyCount(), addKey(), value()

Definition at line 2565 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d && index >= 0 && index < d->keys.size())
        return d->keys[index];
    else
        return QByteArray();
}

keyCount()

int QMetaEnumBuilder::keyCount

(

)

const

Returns the number of keys.

See also

key(), addKey()

Definition at line 2550 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d)
        return d->keys.size();
    else
        return 0;
}

name()

QByteArray QMetaEnumBuilder::name

(

)

const

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

Definition at line 2509 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d)
        return d->name;
    else
        return QByteArray();
}

removeKey()

void QMetaEnumBuilder::removeKey

(

int

index

)

Removes the key at index from this enumerator.

See also

addKey()

Definition at line 2613 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d && index >= 0 && index < d->keys.size()) {
        d->keys.removeAt(index);
        d->values.removeAt(index);
    }
}

setIsFlag()

void QMetaEnumBuilder::setIsFlag

(

bool

value

)

Sets this enumerator to be used as a flag if value is true.

See also

isFlag()

Definition at line 2538 of file qmetaobjectbuilder.cpp.

Referenced by QMetaObjectBuilder::addEnumerator().

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d)
        d->isFlag = value;
}

value()

int QMetaEnumBuilder::value

(

int

index

)

const

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

See also

keyCount(), addKey(), key()

Definition at line 2580 of file qmetaobjectbuilder.cpp.

{
    QMetaEnumBuilderPrivate *d = d_func();
    if (d && index >= 0 && index < d->keys.size())
        return d->values[index];
    else
        return -1;
}

Friends and Related Functions

QMetaObjectBuilder

friend class QMetaObjectBuilder

friend

Definition at line 312 of file qmetaobjectbuilder_p.h.

Properties

_index

int QMetaEnumBuilder::_index

private

Definition at line 310 of file qmetaobjectbuilder_p.h.

_mobj

const QMetaObjectBuilder* QMetaEnumBuilder::_mobj

private

Definition at line 309 of file qmetaobjectbuilder_p.h.

---

The documentation for this class was generated from the following files:

• /src/declarative/qml/qmetaobjectbuilder_p.h
• /src/declarative/qml/qmetaobjectbuilder.cpp