summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2010-01-13 13:13:07 +0100
committerJesper Thomschutz <jesper.thomschutz@nokia.com>2010-01-14 10:35:30 +0100
commitf3b819ecfbf19a4ca1aad037fad6e8675fe2a25a (patch)
treec8a971ecfafb1ce798042e9908e52bc57dd37cd1
parentb126b0fd10dd65a20602f070fa3c347885ac8863 (diff)
doc: This bug wasn't really a bug; it just required clarification.
The reported bug was actually not a bug. It is ok to pass the enum value as a string here, because the enumeration type has been registered with the meta-object system with the Q_ENUMS() macro. However, I have added a bit of text to clarify things a bit. Task-number: QTBUG-7158 (cherry picked from commit cd0772335cc9bcedd582cacc834bf4609ca650b0)
-rw-r--r--doc/src/objectmodel/properties.qdoc19
-rw-r--r--doc/src/snippets/code/doc_src_properties.qdoc2
2 files changed, 12 insertions, 9 deletions
diff --git a/doc/src/objectmodel/properties.qdoc b/doc/src/objectmodel/properties.qdoc
index 0f2dd54e1e..7594e59979 100644
--- a/doc/src/objectmodel/properties.qdoc
+++ b/doc/src/objectmodel/properties.qdoc
@@ -208,17 +208,20 @@
the property type. The meta-object compiler enforces these
requirements.
- Given a pointer to an instance of MyClass or a pointer to an
- instance of QObject that happens to be an instance of MyClass, we
- have two ways to set its priority property.
+ Given a pointer to an instance of MyClass or a pointer to a
+ QObject that is an instance of MyClass, we have two ways to set
+ its priority property:
\snippet doc/src/snippets/code/doc_src_properties.qdoc 6
- In the example, the enumeration type used for the property type
- was locally declared in MyClass. Had it been declared in another
- class, its fully qualified name (i.e., OtherClass::Priority) would
- be required. In addition, that other class must also inherit
- QObject and register the enum type using Q_ENUMS().
+ In the example, the enumeration type that is the property type is
+ declared in MyClass and registered with the \l{Meta-Object System}
+ using the Q_ENUMS() macro. This makes the enumeration values
+ available as strings for use as in the call to setProperty(). Had
+ the enumeration type been declared in another class, its fully
+ qualified name (i.e., OtherClass::Priority) would be required, and
+ that other class would also have to inherit QObject and register
+ the enumeration type there using the Q_ENUMS() macro.
A similar macro, Q_FLAGS(), is also available. Like Q_ENUMS(), it
registers an enumeration type, but it marks the type as being a
diff --git a/doc/src/snippets/code/doc_src_properties.qdoc b/doc/src/snippets/code/doc_src_properties.qdoc
index 2567b2a331..9845abb46a 100644
--- a/doc/src/snippets/code/doc_src_properties.qdoc
+++ b/doc/src/snippets/code/doc_src_properties.qdoc
@@ -112,7 +112,7 @@ MyClass *myinstance = new MyClass;
QObject *object = myinstance;
myinstance->setPriority(MyClass::VeryHigh);
-object->setProperty("priority", (int)MyClass::VeryHigh);
+object->setProperty("priority", "VeryHigh");
//! [6]