aboutsummaryrefslogtreecommitdiffstats
path: root/src/declarative/items/qsgfocusscope.cpp
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2011-08-08 18:03:31 +1000
committerQt by Nokia <qt-info@nokia.com>2011-08-09 10:11:27 +0200
commit1a84b190bd1a2781d03f13fa43ab92bf34809041 (patch)
treebe4523371df6d2d07041d95c070a22f4724cf031 /src/declarative/items/qsgfocusscope.cpp
parent955c2b0f29dc709a5cc7e563c21f0f2cf2370336 (diff)
Add documentation
Copy the documentation back to the scenegraph items, and update it to the new module syntax. Change-Id: I5d030a231f991a209a8593ddb069e1b6cd03580e Reviewed-on: http://codereview.qt.nokia.com/2735 Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
Diffstat (limited to 'src/declarative/items/qsgfocusscope.cpp')
-rw-r--r--src/declarative/items/qsgfocusscope.cpp16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/declarative/items/qsgfocusscope.cpp b/src/declarative/items/qsgfocusscope.cpp
index 156869120d..2018d5ce7d 100644
--- a/src/declarative/items/qsgfocusscope.cpp
+++ b/src/declarative/items/qsgfocusscope.cpp
@@ -43,7 +43,21 @@
QT_BEGIN_NAMESPACE
-QSGFocusScope::QSGFocusScope(QSGItem *parent)
+/*!
+ \qmlclass FocusScope QSGFocusScope
+ \inqmlmodule QtQuick 2
+ \ingroup qml-basic-interaction-elements
+
+ \brief The FocusScope object explicitly creates a focus scope.
+ \inherits Item
+
+ Focus scopes assist in keyboard focus handling when building reusable QML
+ components. All the details are covered in the
+ \l {qmlfocus}{keyboard focus documentation}.
+
+ \sa {declarative/keyinteraction/focus}{Keyboard focus example}
+*/
+QSGFocusScope::QSGFocusScope(QSGItem *parent)
: QSGItem(parent)
{
setFlag(ItemIsFocusScope);