From 12a5ddf456ba8549645a8cb28a8b4ed6197a14da Mon Sep 17 00:00:00 2001 From: Matthew Vogt Date: Mon, 30 Jan 2012 14:16:15 +1000 Subject: Import relevant source from Qt 4.8 Change-Id: I5078db4081d95290c54f39d3c0efc2fc2f62e6a6 --- doc/src/declarative/qmlinuse.qdoc | 499 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 499 insertions(+) create mode 100644 doc/src/declarative/qmlinuse.qdoc (limited to 'doc/src/declarative/qmlinuse.qdoc') diff --git a/doc/src/declarative/qmlinuse.qdoc b/doc/src/declarative/qmlinuse.qdoc new file mode 100644 index 00000000..c17d6448 --- /dev/null +++ b/doc/src/declarative/qmlinuse.qdoc @@ -0,0 +1,499 @@ +/**************************************************************************** +** +** Copyright (C) 2012 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$ +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page qmlinuse.html +\title Using QML elements + +\raw HTML +
+
+
+

+ QML Elements

+ +
+
+
+

+ Groups Of Related QML Elements

+

+ QML Elements are grouped by their respective functionalities. Certain elements are + suited for building complex components while other elements strictly dictate appearances + and color.

+
+
+

+ add something about elements in use in general

+
+
+ +
+
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Basic QML Elements

+

+ Basic elements can be extended to form more complex elements.

+ Elements: +
    +
  • Item Element + - The Item is the most basic of all visual items in QML. Many visual elements inherit + properties from the Item element.
    • +
  • Component Element + - The Component element encapsulates a QML component definition.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Visual Elements

+

+ Visual elements offer various interactive and graphical functionalities. Visual + elements can directly set properties that dictate appearances.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Animation and Transition Elements

+

+ Animation and transition elements control animation behaviors. Animations can run + in parallel or in series for different value types. +

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Interaction Elements

+

+ These elements define basic interactions such as touch movements and focus management.

+ Elements: +
    +
  • Flickable Element - The Flickable item provides a surface that can be "flicked".
    • +
  • Flipable Element - The Flipable item provides a surface that can be flipped or reflected.
    • +
  • FocusPanel Element - The FocusPanel item explicitly creates a focus panel.
    • +
  • FocusScope Element - The FocusScope object explicitly creates a focus scope for focus management.
    • +
  • PinchArea Element - The PinchArea item enables simple pinch gesture handling.
    • +
  • KeyNavigation Element - The KeyNavigation attached property supports key navigation by arrow keys.
    • +
  • Keys Element - The Keys attached property provides key handling to Items.
    • +
  • MouseArea Element - The MouseArea item enables simple mouse handling.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Event Elements

+

+ Key and mouse events information are provided in these event elements.

+ Elements: +
    +
  • KeyEvent Element - The KeyEvent + object provides information about a key event.
    • +
  • MouseEvent Element - The MouseEvent + object provides information about a mouse event.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Positioning Elements

+

+ Using positioning elements, layouts can be defined and their children accessed through + an index.

+ Elements: +
    +
  • Column Element - The Column + item arranges its children vertically.
    • +
  • Flow Element - The Flow item + arranges its children side by side, wrapping as necessary.
    • +
  • Grid Element - The Grid item + positions its children in a grid.
    • +
  • Row Element - The Row item + arranges its children horizontally.
    • +
  • Repeater Element - The Repeater element allows you to repeat an Item-based component using a model.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+ +

QML State Elements

+

+ States and groups of states are formed using state elements.

+ Elements: +
    +
  • AnchorChanges Element - The AnchorChanges element allows you to change the anchors of an item in a state.
    • +
  • ParentChange Element - The ParentChange element allows you to reparent an Item in a state change.
    • +
  • PropertyChanges Element - The PropertyChanges element describes new property bindings or values for a state.
    • +
  • State Element - The State + element defines configurations of objects and properties.
    • +
  • StateChangeScript Element - The StateChangeScript element allows you to run a script in a state.
    • +
  • StateGroup Element - The StateGroup element provides state support for non-Item elements.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Transform Elements

+

+ Advanced handling of transformations is controlled in transform elements.

+ Elements: +
    +
  • Rotation Element - The Rotation object provides a way to rotate an Item.
    • +
  • Scale Element - The Scale element provides a way to scale an Item.
    • +
  • Transform Element - The Transform element provide a way of building advanced transformations on Items.
    • +
  • Translate Element - The Translate object provides a way to move an Item without changing its x or y properties.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

QML Utility Elements

+

+ These elements handle assorted operations such as event timing, Qt enumerations, + and font loading.

+ Elements: +
    +
  • Binding Element - The Binding element allows arbitrary property bindings to be created.
    • +
  • Connections Element - A Connections element describes generalized connections to signals.
    • +
  • DoubleValidator Element - Provides a validator for non-integer numbers.
    • +
  • FontLoader Element - The FontLoader element allows fonts to be loaded by name or URL.
    • +
  • IntValidator Element - This element provides a validator for integer values.
    • +
  • LayoutItem Element - The LayoutItem element allows declarative UI elements to be placed inside Qt's Graphics View layouts.
    • +
  • Loader Element - The Loader item allows dynamically loading an Item-based subtree from a URL or Component.
    • +
  • Package Element - Package provides a bundle for shared contexts in multiple views.
    • +
  • Qt Element - The QML global Qt object provides useful enums and functions from Qt.
    • +
  • QtObject Element - The QtObject element is the most basic element in QML.
    • +
  • RegExpValidator Element - This element provides a validator for regular expressions.
    • +
  • SystemPalette Element - The SystemPalette element provides access to the Qt palettes.
    • +
  • Timer Element - The Timer item triggers a handler at a specified interval.
    • +
  • WorkerScript Element - The WorkerScript element enables the use of threads in QML.
    • +
+
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Models and View Elements

+

+ Models and views are used to organize data and control their layouts using delegates. + Models dictate the data formation and views control the layouts of data in the model.

+ View Elements: +
    +
  • GridView Element - The GridView item provides a grid view of items provided by a model.
    • +
  • ListView Element - The ListView item provides a list view of items provided by a model.
    • +
  • PathView Element - The PathView element lays out model-provided items on a path.
    • +
  • WebView Element - The WebView item allows you to add Web content to a canvas.
    • +
+ Model Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Paths

+

+ QML components can be arranged along paths. Path elements allow control over different + path types.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Particle Elements

+

+ Particle effects are declared and controlled using particle elements.

+ Elements: + +
+
+ +
+
+
+
+ +

+ image heading

+ +

+ img descr.

+
+ +
+
+

Bridge Elements

+

+ Bridge elements allow direct communication between C++ and QML entities.

+ Elements: +
    +
  • LayoutItem Element - The LayoutItem element allows declarative UI elements to be placed inside Qt's Graphics View layouts.
    • +
+
+
+ +\endraw + + + +*/ + -- cgit v1.2.3