Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QDesignerMetaEnumInterface Class Referenceabstract

QDesignerMetaEnumInterface is part of \QD's introspection interface and represents an enumeration. More...

#include <abstractintrospection_p.h>

+ Collaboration diagram for QDesignerMetaEnumInterface:

Public Member Functions

 QDesignerMetaEnumInterface ()
 Constructs a QDesignerMetaEnumInterface object.
 
virtual ~QDesignerMetaEnumInterface ()
 Destroys the QDesignerMetaEnumInterface object.
 
virtual bool isFlag () const =0
 Returns true if this enumerator is used as a flag.
 
virtual QString key (int index) const =0
 Returns the key with the given index.
 
virtual int keyCount () const =0
 Returns the number of keys.
 
virtual int keyToValue (const QString &key) const =0
 Returns the integer value of the given enumeration key, or -1 if key is not defined.
 
virtual int keysToValue (const QString &keys) const =0
 Returns the value derived from combining together the values of the keys using the OR operator, or -1 if keys is not defined.
 
virtual QString name () const =0
 Returns the name of the enumerator (without the scope).
 
virtual QString enumName () const =0
 
virtual QString scope () const =0
 Returns the scope this enumerator was declared in.
 
virtual QString separator () const =0
 Returns the separator to be used when building enumeration names.
 
virtual int value (int index) const =0
 Returns the value with the given index; or returns -1 if there is no such value.
 
virtual QString valueToKey (int value) const =0
 Returns the string that is used as the name of the given enumeration value, or QString::null if value is not defined.
 
virtual QString valueToKeys (int value) const =0
 Returns a byte array of '|'-separated keys that represents the given value.
 

Detailed Description

QDesignerMetaEnumInterface is part of \QD's introspection interface and represents an enumeration.

Since
4.4

\inmodule QtDesigner

The QDesignerMetaEnumInterface class provides meta-data about an enumerator.

See also
QDesignerMetaObjectInterface

Definition at line 24 of file abstractintrospection_p.h.

Constructor & Destructor Documentation

◆ QDesignerMetaEnumInterface()

QDesignerMetaEnumInterface::QDesignerMetaEnumInterface ( )
default

Constructs a QDesignerMetaEnumInterface object.

◆ ~QDesignerMetaEnumInterface()

QDesignerMetaEnumInterface::~QDesignerMetaEnumInterface ( )
virtualdefault

Destroys the QDesignerMetaEnumInterface object.

Member Function Documentation

◆ enumName()

virtual QString QDesignerMetaEnumInterface::enumName ( ) const
pure virtual

◆ isFlag()

virtual bool QDesignerMetaEnumInterface::isFlag ( ) const
pure virtual

Returns true if this enumerator is used as a flag.

◆ key()

virtual QString QDesignerMetaEnumInterface::key ( int index) const
pure virtual

Returns the key with the given index.

◆ keyCount()

virtual int QDesignerMetaEnumInterface::keyCount ( ) const
pure virtual

Returns the number of keys.

◆ keysToValue()

virtual int QDesignerMetaEnumInterface::keysToValue ( const QString & keys) const
pure virtual

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.

◆ keyToValue()

virtual int QDesignerMetaEnumInterface::keyToValue ( const QString & key) const
pure virtual

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

◆ name()

virtual QString QDesignerMetaEnumInterface::name ( ) const
pure virtual

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

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

+ Here is the caller graph for this function:

◆ scope()

virtual QString QDesignerMetaEnumInterface::scope ( ) const
pure virtual

Returns the scope this enumerator was declared in.

◆ separator()

virtual QString QDesignerMetaEnumInterface::separator ( ) const
pure virtual

Returns the separator to be used when building enumeration names.

◆ value()

virtual int QDesignerMetaEnumInterface::value ( int index) const
pure virtual

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

◆ valueToKey()

virtual QString QDesignerMetaEnumInterface::valueToKey ( int value) const
pure virtual

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

◆ valueToKeys()

virtual QString QDesignerMetaEnumInterface::valueToKeys ( int value) const
pure virtual

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


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