Add documentation for all font properties.

[profile/ivi/qtdeclarative.git] / src / qml / doc / src / typesystem / basictypes.qdoc

diff --git a/src/qml/doc/src/typesystem/basictypes.qdoc b/src/qml/doc/src/typesystem/basictypes.qdoc
index 0f30a8a..55438c3 100644 (file)
--- a/src/qml/doc/src/typesystem/basictypes.qdoc
+++ b/src/qml/doc/src/typesystem/basictypes.qdoc
@@ -516,7 +516,7 @@ property is only invoked when the property is reassigned to a different object v
 
     The \c font type refers to a font value with the properties of QFont.
 
-    These properties are:
+    The most commonly used properties are:
 
     \list
     \li \l string \c font.family
@@ -527,6 +527,19 @@ property is only invoked when the property is reassigned to a different object v
     \li \l int \c font.pixelSize
     \endlist
 
+    If both \c pointSize and a \c pixelSize are specified, \c pixelSize will be used.
+
+    The following properties are also available:
+
+    \list
+    \li \l enumeration \c font.weight
+    \li \l bool \c font.overline
+    \li \l bool \c font.sstrikeout
+    \li \l enumeration \c font.capitalization
+    \li \l real \c font.letterSpacing
+    \li \l real \c font.wordSpacing
+    \endlist
+
     Example:
     \qml
     Text { font.family: "Helvetica"; font.pointSize: 13; font.bold: true }
@@ -538,6 +551,47 @@ property is only invoked when the property is reassigned to a different object v
 
     This basic type is provided by the QtQuick import.
 
+    Font weighting is classified on a scale from 0 to 99, where a weight of 0 is ultralight,
+    and 99 is extremely black. The following values are supported:
+
+    \table
+    \row
+        \li \c Font.Light
+        \li 25
+    \row
+        \li \c Font.Normal
+        \li 50
+    \row
+        \li \c Font.DemiBold
+        \li 63
+    \row
+        \li \c Font.Bold
+        \li 75
+    \row
+        \li \c Font.Black
+        \li 87
+    \endtable
+
+    Capitalization supports the following values:
+
+    \table
+    \row
+        \li \c Font.MixedCase
+        \li No capitalization change is applied.
+    \row
+        \li \c Font.AllUppercase
+        \li Alters the text to be rendered in all uppercase type.
+    \row
+        \li \c Font.AllLowercase
+        \li Alters the text to be rendered in all lowercase type.
+    \row
+        \li \c Font.SmallCaps
+        \li Alters the text to be rendered in small-caps type.
+    \row
+        \li \c Font.Capitalize
+        \li Alters the text to be rendered with the first character of each word as an uppercase character.
+    \endtable
+
     \sa {QML Basic Types}
 */