summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Boddie <dboddie@trolltech.com>2010-08-05 14:10:12 (GMT)
committerDavid Boddie <dboddie@trolltech.com>2010-08-05 14:10:12 (GMT)
commit301f490e82b21389cf55e3bbbdba4c48d8288fed (patch)
tree4e6d27d279c76414af0e03642b3d5ee031656bf8 /doc
parent1815ad4a6e72ed1996253f0ecb7506ae3e07ca41 (diff)
parent6ca2fe678740f4830de2388e9b2928813561373c (diff)
downloadQt-301f490e82b21389cf55e3bbbdba4c48d8288fed.zip
Qt-301f490e82b21389cf55e3bbbdba4c48d8288fed.tar.gz
Qt-301f490e82b21389cf55e3bbbdba4c48d8288fed.tar.bz2
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/oslo-staging-1 into 4.7
Diffstat (limited to 'doc')
-rw-r--r--doc/src/getting-started/gettingstarted.qdoc8
-rw-r--r--doc/src/getting-started/gettingstartedqml.qdoc46
-rw-r--r--doc/src/images/arrow.pngbin0 -> 583 bytes
-rw-r--r--doc/src/images/qml-texteditor1_button.pngbin0 -> 1670 bytes
-rw-r--r--doc/src/images/qml-texteditor1_editmenu.pngbin0 -> 7358 bytes
-rw-r--r--doc/src/images/qml-texteditor1_filemenu.pngbin0 -> 7078 bytes
-rw-r--r--doc/src/images/qml-texteditor1_simplebutton.pngbin0 -> 1055 bytes
-rw-r--r--doc/src/images/qml-texteditor2_menubar.pngbin0 -> 7975 bytes
-rw-r--r--doc/src/images/qml-texteditor3_textarea.pngbin0 -> 10417 bytes
-rw-r--r--doc/src/images/qml-texteditor3_texteditor.pngbin0 -> 61353 bytes
-rw-r--r--doc/src/images/qml-texteditor4_texteditor.pngbin0 -> 75600 bytes
-rw-r--r--doc/src/images/qml-texteditor5_editmenu.pngbin0 -> 31834 bytes
-rw-r--r--doc/src/images/qml-texteditor5_filemenu.pngbin0 -> 21688 bytes
-rw-r--r--doc/src/images/qml-texteditor5_newfile.pngbin0 -> 92794 bytes
-rw-r--r--doc/src/overviews.qdoc1
-rw-r--r--doc/src/snippets/declarative/SelfDestroyingRect.qml60
-rw-r--r--doc/src/widgets-and-layouts/widgets.qdoc1
-rw-r--r--doc/src/windows-and-dialogs/dialogs.qdoc2
18 files changed, 92 insertions, 26 deletions
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index 145982b..e58305a 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -30,7 +30,13 @@
\group gettingStarted
- Following is a list.
+ \section1
+ Creating applications using Qt and QML is easy enough once you get started.
+ To get you started we have created two tutorials creating two similar applications,
+ but using diiferent approaches. One tutorial implements the user interface using
+ QML, while the other implements the whole application using traditional Qt.
+
+ Please click on the links below to start the ride.
\generatelist{related}
*/
diff --git a/doc/src/getting-started/gettingstartedqml.qdoc b/doc/src/getting-started/gettingstartedqml.qdoc
index 2bfb71c..93f6f88 100644
--- a/doc/src/getting-started/gettingstartedqml.qdoc
+++ b/doc/src/getting-started/gettingstartedqml.qdoc
@@ -32,27 +32,30 @@
\ingroup gettingStarted
Welcome to the world of QML - the declarative UI language. In this Getting
- Started guide, we will create a simple text editor application using QML.
- After reading this guide, you should be ready to develop your own applications
- using QML and Qt C++.
+ Started guide, we create a simple text editor application using QML.
+ After reading this guide, you should be ready to start developing your own
+ applications using QML and Qt C++.
+ \example tutorials/gettingStarted/gsQml
+
\section1 QML to Build User Interfaces
- The application we are building is a simple text editor that will load, save,
- and perform some text manipulation. This guide will consist of two parts. The
- first part will involve designing the application layout and behaviors using
- declarative language in QML. For the second part, file loading and saving will
- be implemented using Qt C++. Using
- \l {The Meta-Object System}{Qt's Meta-Object System}, we can expose C++ functions
- as properties that QML elements can use. Utilizing QML and Qt C++, we can
- efficiently decouple the interface logic from the application logic.
+ Here we are building is a simple text editor that con load, save,
+ and perform some text manipulation. This guide consists of two parts. The
+ first part involves designing the application layout and behaviors using
+ declarative language in QML. For the second part, file loading and saving is
+ implemented using Qt C++.
+ Using \l {The Meta-Object System}{Qt's Meta-Object System}, we can expose C++
+ functions as properties that QML elements can use. By utilizing QML and Qt C++,
+ we can efficiently decouple the interface logic from the application logic.
\image qml-texteditor5_editmenu.png
- To run the QML example code, merely provide the included \l{QML Viewer}{qmlviewer}
+ To run the QML example code, we merely provide the included \l{QML Viewer}{qmlviewer}
tool with the QML file as the argument. The C++ portion of this tutorial assumes
that the reader possesses basic knowledge of Qt's compilation procedures.
+ \omit
Tutorial chapters:
\list 1
\o \l {Defining a Button and a Menu}{Defining a Button and a Menu}
@@ -61,6 +64,7 @@
\o \l {Decorating the Text Editor}{Decorating the Text Editor}
\o \l {Extending QML using Qt C++}{Extending QML using Qt C++}
\endlist
+ \endomit
\section1 Defining a Button and a Menu
@@ -104,7 +108,7 @@
is called \c simplebutton. Anchors may bind to other items' anchors, allowing layout
assignments simpler.
- We shall save this code as \c SimpleButton.qml. Running qmlviewer with the file as the
+ We save this code as \c SimpleButton.qml. Running qmlviewer with the file as the
argument will display the grey rectangle with a text label.
\image qml-texteditor1_simplebutton.png
@@ -407,13 +411,9 @@
\image qml-texteditor2_menubar.png
- */
-
- /*!
- \page qml-textEditor3.html
- \title Building a Text Editor
+ \section1 Building a Text Editor
- \section1 Declaring a TextArea
+ \section2 Declaring a TextArea
Our text editor is not a text editor if it didn't contain an editable text area.
QML's \l {TextEdit}{TextEdit} element allows the declaration of a multi-line
@@ -497,12 +497,8 @@
\image qml-texteditor3_texteditor.png
- */
-
- /*!
- \page qml-textEditor4
- \title Decorating the Text Editor
- \section1 Implementing a Drawer Interface
+ \section1 Decorating the Text Editor
+ \section2 Implementing a Drawer Interface
Our text editor looks simple and we need to decorate it. Using QML, we can declare
transitions and animate our text editor. Our menu bar is occupying one-third of the
diff --git a/doc/src/images/arrow.png b/doc/src/images/arrow.png
new file mode 100644
index 0000000..14978c2
--- /dev/null
+++ b/doc/src/images/arrow.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor1_button.png b/doc/src/images/qml-texteditor1_button.png
new file mode 100644
index 0000000..aab64bc
--- /dev/null
+++ b/doc/src/images/qml-texteditor1_button.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor1_editmenu.png b/doc/src/images/qml-texteditor1_editmenu.png
new file mode 100644
index 0000000..af8028b
--- /dev/null
+++ b/doc/src/images/qml-texteditor1_editmenu.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor1_filemenu.png b/doc/src/images/qml-texteditor1_filemenu.png
new file mode 100644
index 0000000..ccc008c
--- /dev/null
+++ b/doc/src/images/qml-texteditor1_filemenu.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor1_simplebutton.png b/doc/src/images/qml-texteditor1_simplebutton.png
new file mode 100644
index 0000000..21ce509
--- /dev/null
+++ b/doc/src/images/qml-texteditor1_simplebutton.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor2_menubar.png b/doc/src/images/qml-texteditor2_menubar.png
new file mode 100644
index 0000000..691a833
--- /dev/null
+++ b/doc/src/images/qml-texteditor2_menubar.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor3_textarea.png b/doc/src/images/qml-texteditor3_textarea.png
new file mode 100644
index 0000000..95abcd6
--- /dev/null
+++ b/doc/src/images/qml-texteditor3_textarea.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor3_texteditor.png b/doc/src/images/qml-texteditor3_texteditor.png
new file mode 100644
index 0000000..bdf6957
--- /dev/null
+++ b/doc/src/images/qml-texteditor3_texteditor.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor4_texteditor.png b/doc/src/images/qml-texteditor4_texteditor.png
new file mode 100644
index 0000000..85d216b
--- /dev/null
+++ b/doc/src/images/qml-texteditor4_texteditor.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor5_editmenu.png b/doc/src/images/qml-texteditor5_editmenu.png
new file mode 100644
index 0000000..7365690
--- /dev/null
+++ b/doc/src/images/qml-texteditor5_editmenu.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor5_filemenu.png b/doc/src/images/qml-texteditor5_filemenu.png
new file mode 100644
index 0000000..7078022
--- /dev/null
+++ b/doc/src/images/qml-texteditor5_filemenu.png
Binary files differ
diff --git a/doc/src/images/qml-texteditor5_newfile.png b/doc/src/images/qml-texteditor5_newfile.png
new file mode 100644
index 0000000..e493941
--- /dev/null
+++ b/doc/src/images/qml-texteditor5_newfile.png
Binary files differ
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index a1773a3..b72df98 100644
--- a/doc/src/overviews.qdoc
+++ b/doc/src/overviews.qdoc
@@ -29,6 +29,7 @@
\page overviews.html
\title All Overviews and HOWTOs
+ \ingroup qt-basic-concepts
\generatelist overviews
*/
diff --git a/doc/src/snippets/declarative/SelfDestroyingRect.qml b/doc/src/snippets/declarative/SelfDestroyingRect.qml
new file mode 100644
index 0000000..f14d2d2
--- /dev/null
+++ b/doc/src/snippets/declarative/SelfDestroyingRect.qml
@@ -0,0 +1,60 @@
+/****************************************************************************
+**
+** 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 QtDeclarative module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** You may use this file under the terms of the BSD license as follows:
+**
+** "Redistribution and use in source and binary forms, with or without
+** modification, are permitted provided that the following conditions are
+** met:
+** * Redistributions of source code must retain the above copyright
+** notice, this list of conditions and the following disclaimer.
+** * Redistributions in binary form must reproduce the above copyright
+** notice, this list of conditions and the following disclaimer in
+** the documentation and/or other materials provided with the
+** distribution.
+** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
+** the names of its contributors may be used to endorse or promote
+** products derived from this software without specific prior written
+** permission.
+**
+** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+//![0]
+import Qt 4.7
+
+Rectangle {
+ id: rect
+ width: 80; height: 80
+ color: "red"
+
+ NumberAnimation on opacity {
+ to: 0
+ duration: 1000
+
+ onRunningChanged: {
+ if (!running) {
+ console.log("Destroying...")
+ rect.destroy();
+ }
+ }
+ }
+}
+//![0]
diff --git a/doc/src/widgets-and-layouts/widgets.qdoc b/doc/src/widgets-and-layouts/widgets.qdoc
index 18b8be1..f2475c2 100644
--- a/doc/src/widgets-and-layouts/widgets.qdoc
+++ b/doc/src/widgets-and-layouts/widgets.qdoc
@@ -29,6 +29,7 @@
\page widgets-and-layouts.html
\title Widgets and Layouts
\ingroup qt-gui-concepts
+ \ingroup qt-basic-concepts
\brief The primary elements for designing user interfaces in Qt.
\section1 Widgets
diff --git a/doc/src/windows-and-dialogs/dialogs.qdoc b/doc/src/windows-and-dialogs/dialogs.qdoc
index 6316dc9..74df2aa 100644
--- a/doc/src/windows-and-dialogs/dialogs.qdoc
+++ b/doc/src/windows-and-dialogs/dialogs.qdoc
@@ -27,11 +27,13 @@
/*!
\group standard-dialogs
+ \ingroup qt-basic-concepts
\title Standard Dialog Classes
*/
/*!
\group dialog-classes
+ \ingroup qt-basic-concepts
\title Classes for Building Dialogs
*/