summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/doc.pri4
-rw-r--r--doc/src/declarative/declarativeui.qdoc11
-rw-r--r--doc/src/demos/spectrum.qdoc35
-rw-r--r--doc/src/examples/imagegestures.qdoc2
-rw-r--r--doc/src/getting-started/examples.qdoc2
-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/index.qdoc2
-rw-r--r--doc/src/overviews.qdoc1
-rw-r--r--doc/src/snippets/code/src_corelib_tools_qscopedpointer.cpp5
-rw-r--r--doc/src/snippets/sharedemployee/employee.h2
-rw-r--r--doc/src/widgets-and-layouts/widgets.qdoc1
-rw-r--r--doc/src/windows-and-dialogs/dialogs.qdoc2
25 files changed, 78 insertions, 43 deletions
diff --git a/doc/doc.pri b/doc/doc.pri
index f748f3d..e1efa21 100644
--- a/doc/doc.pri
+++ b/doc/doc.pri
@@ -19,8 +19,8 @@ $$unixstyle {
QDOC = cd $$QT_SOURCE_TREE/tools/qdoc3/test && set QT_BUILD_TREE=$$QT_BUILD_TREE&& set QT_SOURCE_TREE=$$QT_SOURCE_TREE&& $$QT_BUILD_TREE/bin/qdoc3.exe $$DOCS_GENERATION_DEFINES
QDOC = $$replace(QDOC, "/", "\\")
}
-ADP_DOCS_QDOCCONF_FILE = qt-build-docs.qdocconf
-QT_DOCUMENTATION = ($$QDOC qt-api-only.qdocconf assistant.qdocconf designer.qdocconf \
+ADP_DOCS_QDOCCONF_FILE = -online qt-build-docs.qdocconf
+QT_DOCUMENTATION = ($$QDOC -assistant qt-api-only.qdocconf assistant.qdocconf designer.qdocconf \
linguist.qdocconf qmake.qdocconf qdeclarative.qdocconf) && \
(cd $$QT_BUILD_TREE && \
$$GENERATOR doc-build/html-qt/qt.qhp -o doc/qch/qt.qch && \
diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc
index 42189c0..a22766b 100644
--- a/doc/src/declarative/declarativeui.qdoc
+++ b/doc/src/declarative/declarativeui.qdoc
@@ -41,11 +41,10 @@ and netbooks. Qt Quick consists of the QtDeclarative C++ module, QML, and
the integration of both of these into the Qt Creator IDE. Using the QtDeclarative
C++ module, you can load and interact with QML files from your Qt application.
-QML is an extension to \l
-{http://www.ecma-international.org/publications/standards/Ecma-262.htm}
-{JavaScript}, that provides a mechanism to declaratively build an
-object tree of \l {QML Elements}{QML elements}. QML improves the
-integration between JavaScript and Qt's existing QObject based type
+QML provides mechanisms to declaratively build an object tree using
+\l {QML Elements}{QML elements}. QML improves the integration between
+{http://www.ecma-international.org/publications/standards/Ecma-262.htm}{JavaScript}
+and Qt's existing QObject based type
system, adds support for automatic \l {Property Binding}{property
bindings} and provides \l {Network Transparency}{network transparency}
at the language level.
@@ -87,11 +86,11 @@ application or to build completely new applications. QML is fully \l
\o \l {qdeclarativemodules.html}{Modules}
\o \l {Extending types from QML}
\o \l {qdeclarativedynamicobjects.html}{Dynamic Object Creation}
-\o \l {qmlruntime.html}{The Qt Declarative Runtime}
\endlist
\section1 Using QML with C++
\list
+\o \l {qmlruntime.html}{The Qt Declarative Runtime}
\o \l {Using QML in C++ Applications}
\o \l {Integrating QML with existing Qt UI code}
\o \l {Tutorial: Writing QML extensions with C++}
diff --git a/doc/src/demos/spectrum.qdoc b/doc/src/demos/spectrum.qdoc
new file mode 100644
index 0000000..b720ce1
--- /dev/null
+++ b/doc/src/demos/spectrum.qdoc
@@ -0,0 +1,35 @@
+/****************************************************************************
+**
+** 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$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in a
+** written agreement between you and Nokia.
+**
+** 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 demos/spectrum
+ \title Spectrum Analyzer
+This application is a demo which uses the QtMultimedia APIs to capture and
+play back PCM audio. While either recording or playback is ongoing, the
+application performs real-time level and frequency spectrum analysis,
+displaying the results in its main window.
+*/
diff --git a/doc/src/examples/imagegestures.qdoc b/doc/src/examples/imagegestures.qdoc
index 57479d8..3d4e467 100644
--- a/doc/src/examples/imagegestures.qdoc
+++ b/doc/src/examples/imagegestures.qdoc
@@ -32,8 +32,6 @@
This example shows how to enable gestures for a widget and use gesture input
to perform actions.
- \image imagegestures-example.png Screenshot of the Image Gestures example.
-
We use two classes to create the user interface for the application: \c MainWidget
and \c ImageWidget. The \c MainWidget class is simply used as a container for the
\c ImageWidget class, which we will configure to accept gesture input. Since we
diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc
index b2895ba..1bf86e5 100644
--- a/doc/src/getting-started/examples.qdoc
+++ b/doc/src/getting-started/examples.qdoc
@@ -529,7 +529,7 @@
\title OpenVG Examples
\brief Accessing OpenVG from Qt
- \image openvg-examples.png
+ \image opengl-examples.png
Qt provides support for integration with OpenVG implementations on
platforms with suitable drivers.
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/index.qdoc b/doc/src/index.qdoc
index 499667c..a4294e9 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -96,6 +96,7 @@
<li><a href="designer-manual.html">Qt Designer</a></li>
<li><a href="linguist-manual.html">Qt Linguist</a></li>
<li><a href="assistant-manual.html">Qt Assistant</a></li>
+ <li><a href="qmake-manual.html">Qt qmake</a></li>
<li><a href="http://doc.qt.nokia.com/qtsimulator-1.0/simulator-description.html">Qt Simulator</a></li>
<li><a href="http://qt.nokia.com/developer/eclipse-integration">Integration</a> and <a href="http://qt.nokia.com/products/appdev">add-ins</a></li>
<li><a href="qvfb.html">Virtual Framebuffer</a></li>
@@ -105,4 +106,5 @@
</div>
\endraw
+
*/
diff --git a/doc/src/overviews.qdoc b/doc/src/overviews.qdoc
index c7b88cf..51456ef 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/code/src_corelib_tools_qscopedpointer.cpp b/doc/src/snippets/code/src_corelib_tools_qscopedpointer.cpp
index 088e043..0bd5fdf 100644
--- a/doc/src/snippets/code/src_corelib_tools_qscopedpointer.cpp
+++ b/doc/src/snippets/code/src_corelib_tools_qscopedpointer.cpp
@@ -87,14 +87,9 @@ void myFunction(bool useSubClass)
// is equivalent to:
const QScopedPointer<QWidget> p(new QWidget());
- QWidget *const p = new QWidget();
- // is equivalent to:
- const QScopedPointer<QWidget> p(new QWidget());
-
const QWidget *p = new QWidget();
// is equivalent to:
QScopedPointer<const QWidget> p(new QWidget());
-
//! [2]
//! [3]
diff --git a/doc/src/snippets/sharedemployee/employee.h b/doc/src/snippets/sharedemployee/employee.h
index 18b47e0..2c9ba6f 100644
--- a/doc/src/snippets/sharedemployee/employee.h
+++ b/doc/src/snippets/sharedemployee/employee.h
@@ -48,7 +48,7 @@
class EmployeeData : public QSharedData
{
public:
- EmployeeData() : id(-1) { name.clear(); }
+ EmployeeData() : id(-1) { }
EmployeeData(const EmployeeData &other)
: QSharedData(other), id(other.id), name(other.name) { }
~EmployeeData() { }
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
*/