summaryrefslogtreecommitdiffstats
path: root/doc/src/examples/declarative-camera.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/examples/declarative-camera.qdoc')
-rw-r--r--doc/src/examples/declarative-camera.qdoc69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/src/examples/declarative-camera.qdoc b/doc/src/examples/declarative-camera.qdoc
new file mode 100644
index 000000000..b37e656f3
--- /dev/null
+++ b/doc/src/examples/declarative-camera.qdoc
@@ -0,0 +1,69 @@
+/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\example declarative-camera
+\title QML Camera Example
+
+\brief The Camera Example shows how to use the API to capture a still image
+or video.
+
+\image qml-camera.png
+
+This example demonstrates the basic use of the Camera QML Plugin elements. The
+plugin provides access to the API functionality for camera settings and
+capturing an image.
+
+Most of the QML code supports the user interface for this application with the
+Camera elements being mostly found in \i {declarative-camera.qml} and
+\i {CaptureControls.qml}.
+
+In \i {declarative-camera.qml} the Camera element is initialized with an id
+of \i {camera }, a photo preview is setup, states are implemented for image
+preview or capture and a CaptureControls element is initialized. The initial
+\i state is \i PhotoCapture. The camera element includes a handler, \i onImageCaptured,
+for the \l {imageCaptured} signal. The handler sets up the application to process
+the preview including a change in the user interface state. The PhotoPreview
+element now becomes visible with any key press being picked up by the handler
+in PhotoPreview and returning the state to \i PhotoCapture.
+
+The \i CaptureControls element, which is implemented in \i {CaptureControls.qml},
+generates a column on the right hand side of the screen which includes control
+buttons for \i focus (not initially visible), \i {capture}, \i {flash modes},
+\i {white balance}, \i {exposure compensation}, and if a preview is
+available a \i {preview} button. The last button exits from the application.
+
+When the Capture button is pressed the \i onClicked handler calls
+\l {Camera::captureImage()}{captureImage()}
+
+
+
+
+
+
+
+*/