diff options
Diffstat (limited to 'doc/src/declarative')
-rw-r--r-- | doc/src/declarative/anchor-layout.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/codingconventions.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/declarativeui.qdoc | 97 | ||||
-rw-r--r-- | doc/src/declarative/elements.qdoc | 9 | ||||
-rw-r--r-- | doc/src/declarative/extending-tutorial.qdoc | 1 | ||||
-rw-r--r-- | doc/src/declarative/pics/flipable.gif | bin | 80659 -> 131710 bytes | |||
-rw-r--r-- | doc/src/declarative/pics/spacing_a.png | bin | 547 -> 0 bytes | |||
-rw-r--r-- | doc/src/declarative/pics/spacing_b.png | bin | 560 -> 0 bytes | |||
-rw-r--r-- | doc/src/declarative/qdeclarativedocument.qdoc | 67 | ||||
-rw-r--r-- | doc/src/declarative/qdeclarativemodels.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/qml-intro.qdoc | 4 |
11 files changed, 88 insertions, 96 deletions
diff --git a/doc/src/declarative/anchor-layout.qdoc b/doc/src/declarative/anchor-layout.qdoc index 5c025e5..99f7777 100644 --- a/doc/src/declarative/anchor-layout.qdoc +++ b/doc/src/declarative/anchor-layout.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! -\page anchor-layout.html +\page qml-anchor-layout.html \target anchor-layout \title Anchor-based Layout in QML diff --git a/doc/src/declarative/codingconventions.qdoc b/doc/src/declarative/codingconventions.qdoc index 9403920..aa4feef 100644 --- a/doc/src/declarative/codingconventions.qdoc +++ b/doc/src/declarative/codingconventions.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! -\page codingconventions.html +\page qml-coding-conventions.html \title QML Coding Conventions This document contains the QML coding conventions that we follow in our documentation and examples and recommend that others follow. diff --git a/doc/src/declarative/declarativeui.qdoc b/doc/src/declarative/declarativeui.qdoc index e1c9473..ae64e2a 100644 --- a/doc/src/declarative/declarativeui.qdoc +++ b/doc/src/declarative/declarativeui.qdoc @@ -34,28 +34,36 @@ \brief Qt Quick provides a declarative framework for building highly dynamic, custom user interfaces. -Qt Quick provides a declarative framework for building highly dynamic, -custom user interfaces from a rich set of \l{QML Elements}{QML elements}. -Qt Quick helps programmers and designers collaborate to -build the fluid user interfaces that are becoming common in portable -consumer devices, such as mobile phones, media players, set-top boxes -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{About JavaScript}{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 system, adds support for -automatic \l{Property Binding}{property bindings} and provides +\section1 Introduction + +Qt Quick is a collection of technologies that are designed to help +developers create the kind of intuitive, modern-looking, fluid user +interfaces that are increasingly used on mobile phones, media players, +set-top boxes and other portable devices. + +Qt Quick consists of a rich set of user interface elements, a declarative +language for describing user interfaces and a language runtime. A collection +of C++ APIs is used to integrate these high level features with classic +Qt applications. + +\section2 QML, Elements and the QtDeclarative Module + +User interfaces and their behavior are described using QML, an extension to +\l{About JavaScript}{JavaScript} that lets developers and designers +use a declarative syntax to specify each user interface in terms of +\l{QML Elements}{QML elements}. These elements are a sophisticated set of +graphical and behavioral building blocks that can be combined together in +\l{QML Documents}{QML documents} to build components ranging in complexity +from simple buttons and sliders, to complete Internet-enabled applications. + +QML improves the integration between 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. -The \l{QML Elements}{QML elements} are a sophisticated set of -graphical and behavioral building blocks. These different elements -are combined together in \l{QML Documents}{QML documents} to build -components ranging in complexity from simple buttons and sliders, to -complete Internet-enabled applications like a photo browser for the -popular \l{http://www.flickr.com}{Flickr} photo-sharing site. +The QtDeclarative module implements the interface between the QML language +and the elements available to it. It also provides a C++ API that can be +used to load and interact with QML files from within Qt applications. Qt Quick builds on \l{QML for Qt programmers}{Qt's existing strengths}. QML can be be used to incrementally extend an existing application or @@ -67,32 +75,54 @@ Module. \list \o \l{Introduction to the QML language} -\o \l{QML Tutorial}{Tutorial: 'Hello World'} -\o \l{QML Advanced Tutorial}{Tutorial: 'Same Game'} -\o \l{QML Examples and Demos} \o \l{QML for Qt Programmers} \o \l{Getting Started Programming with QML} \o \l{Beginning Qt Quick} \endlist -\section1 Core QML Features +\list +\o \l{QML Tutorial}{Tutorial: "Hello World"} +\o \l{QML Advanced Tutorial}{Tutorial: "Same Game"} +\o \l{QML Examples and Demos} +\endlist + +\section1 QML Concepts + \list \o \l{QML Documents} \o \l{Property Binding} -\o \l{Network Transparency} \o \l{QML Scope} -\o \l{Integrating JavaScript} -\o \l{Data Models} +\o \l{QML Modules} \o \l{Anchor-based Layout in QML} +\endlist + +\section1 User Interaction + +\list +\o \l{Keyboard Focus in QML} \o \l{QML States} \o \l{QML Animation} -\o \l{Keyboard Focus in QML} -\o \l{QML Modules} +\endlist + +\section1 Handling Data + +\list +\o \l{Using QML Positioner and Repeater Items} +\o \l{QML Data Models} +\o \l{Network Transparency} +\endlist + +\section1 Architecture + +\list +\o \l{Qt Declarative UI Runtime} +\o \l{Integrating JavaScript} \o \l{Extending types from QML} \o \l{Dynamic Object Management in QML} \endlist \section1 Using QML with C++ + \list \o \l{Qt Declarative UI Runtime} \o \l{Using QML in C++ Applications} @@ -102,6 +132,7 @@ Module. \endlist \section1 Reference + \list \o \l{QML Elements} \o \l{QML Global Object} @@ -113,4 +144,12 @@ Module. \o \l{QML Performance} \o \l{QML Coding Conventions} \endlist + +\section1 Online Examples + +\list +\o Forum Nokia: +\l{http://wiki.forum.nokia.com/index.php/Qt_Quick_examples_for_porting}{Qt Quick +examples for porting} +\endlist */ diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index 94abe10..252b964 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -29,12 +29,13 @@ \page qdeclarativeelements.html \target elements \title QML Elements + \brief A dictionary of standard QML elements. - This is a dictionary of all the QML elements available in the \l - {QtDeclarative} {Qt Declarative} module. + This is a dictionary of all standard QML elements made available + in the QtDeclarative module. - To see the QML elements listed by - functional area, \l{Groups Of Related QML Elements} {look here}. + To see the QML elements listed by functional area, see the + \l{Groups Of Related QML Elements} page. \generatelist qmlclasses diff --git a/doc/src/declarative/extending-tutorial.qdoc b/doc/src/declarative/extending-tutorial.qdoc index d128d0f..349ac30 100644 --- a/doc/src/declarative/extending-tutorial.qdoc +++ b/doc/src/declarative/extending-tutorial.qdoc @@ -26,7 +26,6 @@ ****************************************************************************/ /*! - \page qml-extending-tutorial-index.html \title Tutorial: Writing QML extensions with C++ diff --git a/doc/src/declarative/pics/flipable.gif b/doc/src/declarative/pics/flipable.gif Binary files differindex 6386f06..da37b2b 100644 --- a/doc/src/declarative/pics/flipable.gif +++ b/doc/src/declarative/pics/flipable.gif diff --git a/doc/src/declarative/pics/spacing_a.png b/doc/src/declarative/pics/spacing_a.png Binary files differdeleted file mode 100644 index c0fe895..0000000 --- a/doc/src/declarative/pics/spacing_a.png +++ /dev/null diff --git a/doc/src/declarative/pics/spacing_b.png b/doc/src/declarative/pics/spacing_b.png Binary files differdeleted file mode 100644 index 24cf640..0000000 --- a/doc/src/declarative/pics/spacing_b.png +++ /dev/null diff --git a/doc/src/declarative/qdeclarativedocument.qdoc b/doc/src/declarative/qdeclarativedocument.qdoc index 068297a..4aed63f 100644 --- a/doc/src/declarative/qdeclarativedocument.qdoc +++ b/doc/src/declarative/qdeclarativedocument.qdoc @@ -28,34 +28,17 @@ /*! \page qdeclarativedocuments.html \title QML Documents +\brief A description of QML documents and the kind of content they contain. -A QML document is a block of QML source code. QML documents generally correspond to files -stored on a disk or network resource, but can also be constructed directly from text data. +\section1 Introduction -Here is a simple QML document: +A QML document is a block of QML source code. QML documents generally correspond to files +stored on a disk or at a location on a network, but they can also be constructed directly +from text data. -\code -import Qt 4.7 +Here is a simple QML document: -Rectangle { - width: 240; height: 320; - - resources: [ - Component { - id: contactDelegate - Text { - text: modelData.firstName + " " + modelData.lastName - } - } - ] - - ListView { - anchors.fill: parent - model: contactModel - delegate: contactDelegate - } -} -\endcode +\snippet doc/src/snippets/declarative/qml-documents/non-trivial.qml document QML documents are always encoded in UTF-8 format. @@ -96,7 +79,7 @@ Each instance is created with a different value for its \c text property: \o application.qml \row -\o \snippet doc/src/snippets/declarative/qmldocuments.qml 0 +\o \snippet doc/src/snippets/declarative/qmldocuments.qml document \o \qml import Qt 4.7 @@ -153,39 +136,9 @@ These final two examples are behaviorally identical to the original document. \table \row \o -\code -import Qt 4.7 - -Rectangle { - width: 240; height: 320; - - ListView { - anchors.fill: parent - model: contactModel - delegate: Component { - Text { - text: modelData.firstName + " " + modelData.lastName - } - } - } -} -\endcode +\snippet doc/src/snippets/declarative/qml-documents/inline-component.qml document \o -\code -import Qt 4.7 - -Rectangle { - width: 240; height: 320; - - ListView { - anchors.fill: parent - model: contactModel - delegate: Text { - text: modelData.firstName + " " + modelData.lastName - } - } -} -\endcode +\snippet doc/src/snippets/declarative/qml-documents/inline-text-component.qml document \endtable \sa QDeclarativeComponent diff --git a/doc/src/declarative/qdeclarativemodels.qdoc b/doc/src/declarative/qdeclarativemodels.qdoc index 173002a..ace0465 100644 --- a/doc/src/declarative/qdeclarativemodels.qdoc +++ b/doc/src/declarative/qdeclarativemodels.qdoc @@ -28,7 +28,7 @@ /*! \page qdeclarativemodels.html \target qmlmodels -\title Data Models +\title QML Data Models QML items such as ListView, GridView and \l Repeater require Data Models that provide the data to be displayed. diff --git a/doc/src/declarative/qml-intro.qdoc b/doc/src/declarative/qml-intro.qdoc index 9130be0..d735042 100644 --- a/doc/src/declarative/qml-intro.qdoc +++ b/doc/src/declarative/qml-intro.qdoc @@ -58,12 +58,12 @@ would be a property. The basic syntax of an \l{QML Elements}{element} is -\code +\qml SomeElement { id: myObject ... some other things here ... } -\endcode +\endqml Here we are defining a new object. We specify its 'type' first as SomeElement. Then within matching braces { ... } we specify the various parts of our |