diff options
author | Yann Bodson <yann.bodson@nokia.com> | 2009-08-19 23:56:12 (GMT) |
---|---|---|
committer | Yann Bodson <yann.bodson@nokia.com> | 2009-08-19 23:56:12 (GMT) |
commit | 8b58eecf83811044edfc28bb652c605ab5446a07 (patch) | |
tree | 34602cb46265bc7084f5e2653b58256dd68f00e5 /doc | |
parent | 21e87b18698c50bcfe0800509563e71c79aae0bb (diff) | |
download | Qt-8b58eecf83811044edfc28bb652c605ab5446a07.zip Qt-8b58eecf83811044edfc28bb652c605ab5446a07.tar.gz Qt-8b58eecf83811044edfc28bb652c605ab5446a07.tar.bz2 |
Documentation fixes
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/declarative/binding.qdoc | 20 | ||||
-rw-r--r-- | doc/src/declarative/elements.qdoc | 4 | ||||
-rw-r--r-- | doc/src/declarative/qmlintro.qdoc | 26 | ||||
-rw-r--r-- | doc/src/declarative/qmlreference.qdoc | 8 | ||||
-rw-r--r-- | doc/src/declarative/qtdeclarative.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/tutorial2.qdoc | 6 |
6 files changed, 33 insertions, 33 deletions
diff --git a/doc/src/declarative/binding.qdoc b/doc/src/declarative/binding.qdoc index 36a7e77..6168462 100644 --- a/doc/src/declarative/binding.qdoc +++ b/doc/src/declarative/binding.qdoc @@ -1,17 +1,17 @@ -/*! +/*! \page binding.html \title Data Binding \target binding Data binding provides a declarative way of specifying the data associated with objects, as well as the relationship between data of different objects. For example, you could bind the text of a label to the value of a slider: as the value of the slider changed, the label would be automatically updated with the new value. -Bindings are created in Qml when an expression is assigned to a property. For example, the following produces two Rects of equal size (\c rect2 is bound to the size of \c rect1): +Bindings are created in QML when an expression is assigned to a property. For example, the following produces two rectangles of equal size (\c rect2 is bound to the size of \c rect1): \code Rectangle { id: rect1; width: 100; height: 100 } Rectangle { id: rect2; width: rect1.width; height: rect1.height } \endcode -There is also a special \l Bind element, which is typically used to bind from the UI to the underlying UI model (see \l {Passing Data Between C++ and Qml} for an example of this). The bindings above could be expressed using the \l Bind element as: +There is also a special \l Bind element, which is typically used to bind from the UI to the underlying UI model (see \l {Passing Data Between C++ and QML} for an example of this). The bindings above could be expressed using the \l Bind element as: \code Bind { target: rect2; property: "width"; value: rect1.width } @@ -29,8 +29,8 @@ Relevant items can also be bound to the contents of a model - see \l ListView fo Data can be bound to C++ objects - see \l {C++ Data Binding}. */ -/*! -\page qtbinding.html +/*! +\page qtbinding.html \target qtbinding \title C++ Data Binding @@ -41,11 +41,11 @@ The data binding framework is based on Qt's property system (see the Qt document Relevant items can also be bound to the contents of a Qt model. For example, ListView can make use of data from a QListModelInterface-derived model. (QListModelInterface is part of the next generation Model/View architecture being developed for Qt.) -\section1 Passing Data Between C++ and Qml +\section1 Passing Data Between C++ and QML -Data binding provides one method of data transfer between C++ and Qml. +Data binding provides one method of data transfer between C++ and QML. -For example, lets say you want to implement a slider in Qml that changes the screen brightness of the device it is running on. You would start by declaring a brightness property on your QObject-derived class: +For example, lets say you want to implement a slider in QML that changes the screen brightness of the device it is running on. You would start by declaring a brightness property on your QObject-derived class: \code class MyScreen : public QObject { @@ -84,7 +84,7 @@ void setBrightness(int b) \note One important thing to keep in mind is that the changed signal should only be emitted when there is a real change ( \c b \c != \c m_brightness ), or you may get an infinite loop. -Next, make an instance of this class visible to the Qml bind engine: +Next, make an instance of this class visible to the QML bind engine: \code QFxView *view = new QFxView; view->setUrl("MyUI.qml"); @@ -98,7 +98,7 @@ view->execute(); \note Bindings must be made after setUrl() but before execute(). -Finally, in Qml you can make the appropriate bindings, so in \c "MyUI.qml": +Finally, in QML you can make the appropriate bindings, so in \c "MyUI.qml": \code Slider { value: screen.brightness } diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index 8eeacdf..fff1352 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -1,9 +1,9 @@ /*! \page elements.html \target elements -\title Qml Elements +\title QML Elements -The following table lists the Qml elements provided by the Qt Declarative module. +The following table lists the QML elements provided by the Qt Declarative module. \bold {Standard Qt Declarative Elements} diff --git a/doc/src/declarative/qmlintro.qdoc b/doc/src/declarative/qmlintro.qdoc index 77aa3e2..ced2d68 100644 --- a/doc/src/declarative/qmlintro.qdoc +++ b/doc/src/declarative/qmlintro.qdoc @@ -1,26 +1,26 @@ /*! \page qmlintroduction.html -\title Introduction to the Qml language +\title Introduction to the QML language \tableofcontents -\section1 What is Qml? +\section1 What is QML? -Qml is a declarative language designed to describe the user interface of a -program: both what it looks like and how it behaves. In Qml, a user +QML is a declarative language designed to describe the user interface of a +program: both what it looks like and how it behaves. In QML, a user interface is specified as a tree of objects with properties. \section1 What should I know before starting? This introduction is meant for those with little or no programming -experience. JavaScript is used as a scripting language in Qml, so you may want +experience. JavaScript is used as a scripting language in QML, so you may want to learn a bit more about it (\l{JavaScript: The Definitive Guide}) before diving -too deep into Qml. It's also helpful to have a basic understanding of other web +too deep into QML. It's also helpful to have a basic understanding of other web technologies like HTML and CSS, but not required. -\section1 Basic Qml Syntax +\section1 Basic QML Syntax -Qml looks like this: +QML looks like this: \code Rectangle { @@ -94,9 +94,9 @@ Text2 will be updated as well. Note that to refer to other objects, we use their \e id (more information on the id property can be found in a following section). -\section1 Qml Comments +\section1 QML Comments -Commenting in Qml is similar to JavaScript. +Commenting in QML is similar to JavaScript. \list \o Single line comments begin with // and end at the end of the line. \o Multiline comments begin with /* and end with *\/ @@ -106,7 +106,7 @@ Commenting in Qml is similar to JavaScript. Comments are ignored by the engine. The are useful for explaining what you are doing: for referring back to at a later date, or for others reading -your Qml files. +your QML files. Comments can also be used to prevent the execution of code, which is sometimes useful for tracking down problems. @@ -129,7 +129,7 @@ Properties begin with a lowercase letter (with the exception of \l{Attached Prop \section2 Property types -Qml supports properties of many types (\l{Common QML Types}). The basic types include int, +QML supports properties of many types (\l{Common QML Types}). The basic types include int, real, bool, string, color, and lists. \code @@ -141,7 +141,7 @@ Item { } \endcode -Qml properties are what is known as \e typesafe. That is, they only allow you to assign a value that +QML properties are what is known as \e typesafe. That is, they only allow you to assign a value that matches the property type. For example, the scale property of item is a real, and if you try to assign a string to it you will get an error. diff --git a/doc/src/declarative/qmlreference.qdoc b/doc/src/declarative/qmlreference.qdoc index da955dc..8a50547 100644 --- a/doc/src/declarative/qmlreference.qdoc +++ b/doc/src/declarative/qmlreference.qdoc @@ -1,6 +1,6 @@ /*! \page qmlreference.html - \title Qml Reference + \title QML Reference \target qtdeclarativemainpage @@ -12,7 +12,7 @@ Building fluid applications is done declaratively, rather than procedurally. That is, you specify \e what the UI should look like and how it should behave - rather than specifying step-by-step \e how to build it. Specifying a UI declaratively + rather than specifying step-by-step \e how to build it. Specifying a UI declaratively does not just include the layout of the interface items, but also the way each individual item looks and behaves and the overall flow of the application. @@ -21,7 +21,7 @@ \o \l {qmlexamples}{Examples} \o \l {tutorial}{Tutorial: 'Hello World'} \o \l {tutorials-declarative-contacts.html}{Tutorial: 'Introduction to QML'} - \o \l {Introduction to the Qml language} (in progress) + \o \l {Introduction to the QML language} (in progress) \endlist Core Features: @@ -36,6 +36,6 @@ QML Reference: \list - \o \l {elements}{Qml Elements} + \o \l {elements}{QML Elements} \endlist */ diff --git a/doc/src/declarative/qtdeclarative.qdoc b/doc/src/declarative/qtdeclarative.qdoc index ccfe4a6..6abcd92 100644 --- a/doc/src/declarative/qtdeclarative.qdoc +++ b/doc/src/declarative/qtdeclarative.qdoc @@ -81,7 +81,7 @@ QML Reference: \list \o \l {QML Format} - \o \l {elements}{Qml Elements} + \o \l {elements}{QML Elements} \endlist C++ Reference: diff --git a/doc/src/declarative/tutorial2.qdoc b/doc/src/declarative/tutorial2.qdoc index 410d119..9c1e98b 100644 --- a/doc/src/declarative/tutorial2.qdoc +++ b/doc/src/declarative/tutorial2.qdoc @@ -1,4 +1,4 @@ -/*! +/*! \page tutorial2.html \title Tutorial 2 - Some colors \target tutorial2 @@ -74,7 +74,7 @@ Item { } \endcode -The root element of our component is an \c Item. It is the most basic 'Fx' element in Qml and is often used as a container for other elements. +The root element of our component is an \c Item. It is the most basic element in QML and is often used as a container for other elements. \code property var color @@ -93,7 +93,7 @@ Our cell component is basically a colored rectangle. The \c anchors.fill property is a convenient way to set the size of an element. In this case the \c Rect will have the same size as its parent. -We bind the \c color property of this \c Rect to the color property of our component. +We bind the \c color property of this \c Rectangle to the color property of our component. \code MouseRegion { |