src/declarative/util/qdeclarativesystempalette.cpp
changeset 33 3e2da88830cd
parent 30 5dc02b23752f
child 37 758a864f9613
--- a/src/declarative/util/qdeclarativesystempalette.cpp	Tue Jul 06 15:10:48 2010 +0300
+++ b/src/declarative/util/qdeclarativesystempalette.cpp	Wed Aug 18 10:37:55 2010 +0300
@@ -59,22 +59,25 @@
 /*!
     \qmlclass SystemPalette QDeclarativeSystemPalette
     \since 4.7
-    \brief The SystemPalette item gives access to the Qt palettes.
-    \sa QPalette
+    \brief The SystemPalette element provides access to the Qt palettes.
 
-    Example:
-    \qml
-    SystemPalette { id: myPalette; colorGroup: Qt.Active }
+    The SystemPalette element provides access to the Qt application
+    palettes. This provides information about the standard colors used 
+    for application windows, buttons and other features. These colors
+    are grouped into three \e {color groups}: \c Active, \c Inactive,
+    and \c Disabled.  See the QPalette documentation for details about
+    color groups and the properties provided by SystemPalette.
 
-    Rectangle {
-        width: 640; height: 480
-        color: myPalette.window
-        Text {
-            anchors.fill: parent
-            text: "Hello!"; color: myPalette.windowText
-        }
-    }
-    \endqml
+    This can be used to color items in a way that provides a more
+    native look and feel.
+
+    The following example creates a palette from the \c Active color
+    group and uses this to color the window and text items
+    appropriately:
+
+    \snippet doc/src/snippets/declarative/systempalette.qml 0
+
+    \sa QPalette
 */
 QDeclarativeSystemPalette::QDeclarativeSystemPalette(QObject *parent)
     : QObject(*(new QDeclarativeSystemPalettePrivate), parent)
@@ -258,10 +261,15 @@
 }
 
 /*!
-    \qmlproperty QDeclarativeSystemPalette::ColorGroup SystemPalette::colorGroup
+    \qmlproperty enumeration SystemPalette::colorGroup
+
+    The color group of the palette. This can be one of:
 
-    The color group of the palette. It can be Active, Inactive or Disabled.
-    Active is the default.
+    \list
+    \o SystemPalette.Active (default)
+    \o SystemPalette.Inactive
+    \o SystemPalette.Disabled
+    \endlist
 
     \sa QPalette::ColorGroup
 */