summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qmetaobject.cpp
diff options
context:
space:
mode:
authorDheerendra Purohit <dheerendra@pthinks.com>2025-07-08 14:59:21 +0530
committerDheerendra Purohit <dheerendra@pthinks.com>2025-07-09 05:22:39 +0000
commit3f6b128d7e4be234858ae5171b5ce7cc76c2af14 (patch)
tree4d044b08dbe8473d3a5db120674d87d4633c3724 /src/corelib/kernel/qmetaobject.cpp
parent127468e053c84e089f0afc87704758ae360406e9 (diff)
Doc: Add QMetaEnum usage snippet to detailed description
The QMetaEnum documentation lacked a code snippet showing how to convert enum values to strings using QMetaEnum::fromType() and Q_ENUM. Pick-to: 6.10 6.9 Fixes: QTBUG-60355 Change-Id: I9581625d4889ebad8c5741aa35a30acafb4ce14c Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src/corelib/kernel/qmetaobject.cpp')
-rw-r--r--src/corelib/kernel/qmetaobject.cpp14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp
index 2356611a5cf..de5f27f9619 100644
--- a/src/corelib/kernel/qmetaobject.cpp
+++ b/src/corelib/kernel/qmetaobject.cpp
@@ -3149,6 +3149,20 @@ bool QMetaMethod::invokeOnGadget(void *gadget,
representation. The scope() function returns the class scope this
enumerator was declared in.
+ To use QMetaEnum functionality, register the enumerator within the meta-object
+ system using the Q_ENUM macro.
+
+ \code
+ enum AppleType {
+ Big,
+ Small
+ };
+ Q_ENUM(AppleType)
+
+ QMetaEnum metaEnum = QMetaEnum::fromType<ModelApple::AppleType>();
+ qDebug() << metaEnum.valueToKey(ModelApple::Big);
+ \endcode
+
\sa QMetaObject, QMetaMethod, QMetaProperty
*/