Quick features.
To run the sample applications, open them in Qt Creator or use the included
-\l {Protoyping with qmlscene}{qmlscene} tool.
+\l {Prototyping with qmlscene}{qmlscene} tool.
Some of these code samples have a corresponding \l{qtquick-tutorials}{tutorial}.
The Qt Quick features are covered in the \l {qtquick-overviews}{main page}.
\section2 Viewing the example
-To view what you have created, run the \l{Protoyping with qmlscene}{qmlscene} tool (located in the \c bin directory) with your filename as the first argument.
+To view what you have created, run the \l{Prototyping with qmlscene}{qmlscene} tool (located in the \c bin directory) with your filename as the first argument.
For example, to run the provided completed Tutorial 1 example from the install location, you would type:
\code
by the plugin
\endlist
\li Write a project file for the plugin
- \li Create a \l{Adding Module Metadata with a qmldir file}{qmldir file} to
+ \li Create a \l{Module Definition qmldir Files}{qmldir file} to
describe the plugin
\endlist
SOURCES += qexampleqmlplugin.cpp
\endcode
- Finally, a \l{Adding Module Metadata with a qmldir file}{qmldir file} is required
+ Finally, a \l{Module Definition qmldir Files}{qmldir file} is required
in the \c com/nokia/TimeExample directory to describe the plugin and the types that it
exports. The plugin includes a \c Clock.qml file along with the \c qmlqtimeexampleplugin
that is built by the project (as shown above in the \c .pro file) so both of these
The \c rect type refers to a value with \c x, \c y, \c width and \c height attributes.
For example, to read the \c width and \c height values of the \l Item
-\l {Item::}{childrenRect} rect-type type property:
+\l {Item::childrenRect.x}{childrenRect} rect-type type property:
\qml
Rectangle {
****************************************************************************/
/*!
\module QtQml
-\title Qt QML - C++ Classes
+\title Qt QML Module - C++ Classes
\brief The C++ API provided by the Qt QML module
To include the definitions of the module's classes, use the
\section1 Reference Documentation
+Additional Qt QML information:
\list
-\li \l{QML Types Provided By The QtQml Module}{Qt QML - QML Type Reference}
-\li \l{Qt QML - C++ Classes}
-\li \l{Qt Quick} module documentation
-\li \l{QML Application Developer Resources} - information for application development with QML and Qt Quick
-\li \l{Qt QML Release Notes}
+\li \l{Qt QML Module - C++ Classes} - the C++ API provided by the
+ Qt QML module
+\li \l{Qt QML Release Notes} - list of changes and
+ additions in the Qt QML module
+\endlist
+
+Further information for writing QML applications:
+\list
+\li \l{QML Application Developer Resources}
+ - essential information for application development with QML and Qt Quick
+\li \l{Qt Quick} - documentation for the Qt Quick module, which provides a
+ visual canvas, an animation framework, model/view components and more for
+ building fluid user interfaces and applications with QML
\endlist
*/
types and JavaScript resources into a given namespace.
The generic form of a module import is as follows:
-\qml
+\code
import <ModuleIdentifier> <Version.Number> [as <Qualifier>]
-\endqml
+\endcode
\list
\li The \c <ModuleIdentifier> is an identifier specified in dotted URI
\endlist
An example of an unqualified module import is as follows:
-\qml
+\code
import QtQuick 2.0
-\endqml
+\endcode
This import allows the use of all of the types provided by the \c QtQuick
module without needing to specify a qualifier. For example, the client code to
\endqml
An example of a qualified module import is as follows:
-\qml
+\code
import QtQuick 2.0 as Quick
-\endqml
+\endcode
This import allows multiple modules which provide conflicting type names to be
imported at the same time, however since each usage of a type provided by a
JavaScript resource must have an identifier by which it is accessed.
The generic form of a JavaScript resource import is as follows:
-\qml
+\code
import "<JavaScriptFile>" as <Identifier>
-\endqml
+\endcode
Note that the \c <Identifier> must be unique within a QML document, unlike the
local namespace qualifier which can be applied to module imports.
\value Pixmap The Image Provider provides QPixmap images.
The QQuickImageProvider::requestPixmap() method will be called for all image requests.
\value Texture The Image Provider provides QSGTextureProvider based images.
- The QQuickImageProvider::requestTexture() method will be called for all image requests. \omitvalue
+ The QQuickImageProvider::requestTexture() method will be called for all image requests.
+ \omitvalue Invalid
*/
/*!
\li Subclass QQmlExtensionPlugin, implement registerTypes() method
to register types using qmlRegisterType(), and export the class using the Q_EXPORT_PLUGIN2() macro
\li Write an appropriate project file for the plugin
- \li Create a \l{Adding Module Metadata with a qmldir file}{qmldir file} to describe the plugin
+ \li Create a \l{Module Definition qmldir Files}{qmldir file} to describe the plugin
\endlist
QML extension plugins can be used to provide either application-specific or
...
\endcode
- Finally, a \l{Adding Module Metadata with a qmldir file}{qmldir file} is required in the \c com/nokia/TimeExample directory
+ Finally, a \l{Module Definition qmldir Files}{qmldir file} is required in the \c com/nokia/TimeExample directory
that describes the plugin. This directory includes a \c Clock.qml file that
should be bundled with the plugin, so it needs to be specified in the \c qmldir
file:
The full source code is available in the \l {qml/cppextensions/plugins}{plugins example}.
- The \l {Tutorial: Extending QML with C++} also contains a chapter
+ The \l {Writing QML Extensions with C++} tutorial also contains a chapter
on creating QML plugins.
Note that the QtQuick 1 version is called QDeclarativeExtensionPlugin.
A QML document defines a hierarchy of objects with a highly-readable,
structured layout. Every QML document consists of two parts: an imports
section and an object declaration section. The types and functionality most
-common to user interfaces are provided in the \l{Qt Quick Module}{QtQuick}
+common to user interfaces are provided in the \l{QtQuick}
import.
\section2 Importing and Using the QtQuick Module
-To use the \l{Qt Quick Module}{QtQuick} module, a QML document needs to
+To use the \l{QtQuick} module, a QML document needs to
import it. The import syntax looks like this:
\qml
import QtQuick 2.0
\endqml
-The types and functionality that \l{Qt Quick Module}{QtQuick} provides can now
+The types and functionality that \l{QtQuick} provides can now
be used in the QML document!
\section2 Defining an Object Hierarchy
The object declaration in a QML document defines what will be displayed in the
-visual scene. \l{Qt Quick Module}{QtQuick} provides the basic building blocks
+visual scene. \l{QtQuick} provides the basic building blocks
for all user interfaces, including objects to display images and text, and to
handle user input.
\section2 Putting it Together
The \l Rectangle and \l Text types used in the above example are both provided
-by the \l{Qt Quick Module}{QtQuick} import. To use them, we need to import
-\l{Qt Quick Module}{QtQuick}. Putting the import and object declaration
+by the \l{QtQuick} import. To use them, we need to import
+\l{QtQuick}. Putting the import and object declaration
together, we get a complete QML document:
\qml
\section1 Loading and Displaying the QML Document
To display the graphical scene defined by the QML document, it may be loaded
-with the \l{Protoyping with qmlscene}{qmlscene} tool. The
-\l{Protoyping with qmlscene}{qmlscene} tool should be installed into the
+with the \l{Prototyping with qmlscene}{qmlscene} tool. The
+\l{Prototyping with qmlscene}{qmlscene} tool should be installed into the
Qt installation directory. Assuming that the Qt binaries are installed into
or are available in the system executable path, you can display the QML
document with the following command:
/*!
\ingroup qtquick-positioners
\page qtquick-positioning-layouts.html
-\iningroup qml-features
+\ingroup qml-features
\title Item Layouts
Positioner items are container items that manage the positions and sizes of
/*!
\page qtquick-statesanimations-topic.html
-\title Import Concepts in Qt Quick - States, Transitions and Animations
+\title Important Concepts in Qt Quick - States, Transitions and Animations
\brief Description of the concepts of states, transitions and animations in Qt Quick
In any modern user-interface, transitioning between states and animating
\section1 Reference Documentation
+Additional Qt Quick information:
\list
-\li \l{QML Types Provided by Qt Quick}
-\li \l{Qt Quick Module - C++ Classes}
-\li \l{Qt QML} module documentation
-\li \l{QML Application Developer Resources} - information for application development with QML and Qt Quick
-\li \l{Qt Quick Release Notes}
+\li \l{Qt Quick Module - C++ Classes} - the C++ API provided by the
+ Qt Quick module
+\li \l{Qt Quick Release Notes} - list of changes and
+ additions in the Qt Quick module
+\endlist
+
+Further information for writing QML applications:
+\list
+\li \l{QML Application Developer Resources}
+ - essential information for application development with QML and Qt Quick
+\li \l{Qt Qml} - documentation for the
+ Qt QML module, which provides the QML engine and language infrastructure
\endlist
*/
\qmlproperty Item QtQuick2::KeyNavigation::right
\qmlproperty Item QtQuick2::KeyNavigation::up
\qmlproperty Item QtQuick2::KeyNavigation::down
- \qmlproperty Item QtQuick2::KeyNavigation::tab
- \qmlproperty Item QtQuick2::KeyNavigation::backtab
These properties hold the item to assign focus to
- when the left, right, up or down cursor keys, or the
- tab key are pressed.
+ when the left, right, up or down cursor keys
+ are pressed.
*/
/*!
*/
/*!
+ \class ItemChangeData
+ \internal
+*/
+
+/*!
\enum QQuickItem::TransformOrigin
Controls the point about which simple transforms like scale apply.
}
/*!
- Notify input method on updated query values if needed. \a indicates changed attributes.
+ Notify input method on updated query values if needed. \a queries indicates
+ the changed attributes.
*/
void QQuickItem::updateInputMethod(Qt::InputMethodQueries queries)
{
\endtable
*/
/*!
- \qmlproperty real QtQuick2::Item::z
+ \property QQuickItem::z
Sets the stacking order of sibling items. By default the stacking order is 0.
projects / profile / ivi / qtdeclarative.git / commitdiff