diff options
author | Bea Lam <bea.lam@nokia.com> | 2012-07-03 11:45:26 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-07-05 01:47:53 +0200 |
commit | 422033971f5d74b8ed7dcf3492379403d4d0eb3d (patch) | |
tree | 0b4e599f47fae7ec482e06bc34091c29c9853ab1 /src/quick/doc/src/concepts/statesanimations/topic.qdoc | |
parent | 7481adc7d72665de7873b99f58764f2a6b906c9c (diff) |
Reorganize "concept" pages in QtQuick docs
This removes concepts/topic.qdoc and move this content into individual
concept topic pages under individual directories for each concept to
avoid having a really long "concepts" index page.
This change also:
- Moves components.qdoc ("Defining reusable components") into the
appdevguide/ since it's not specific to QtQuick features - it's more
about how to use a QtQml feature to build QML apps.
- Moves the part of qtqml/doc/src/cppintegration/data.qdoc that
discusses how to use C++ models with QtQuick views into
quick/doc/src/concepts/modelviewsdata/data-cppmodels.qdoc.
Change-Id: Id18a1d56acaaac41714c13cbc94bb3b80f337355
Reviewed-by: Chris Adams <christopher.adams@nokia.com>
Diffstat (limited to 'src/quick/doc/src/concepts/statesanimations/topic.qdoc')
-rw-r--r-- | src/quick/doc/src/concepts/statesanimations/topic.qdoc | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/src/quick/doc/src/concepts/statesanimations/topic.qdoc b/src/quick/doc/src/concepts/statesanimations/topic.qdoc new file mode 100644 index 0000000000..8ca02fd444 --- /dev/null +++ b/src/quick/doc/src/concepts/statesanimations/topic.qdoc @@ -0,0 +1,118 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** 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 qtquick-statesanimations-topic.html +\title Concepts - States 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 +the user-interface is highly beneficial. These are first-class concepts in +Qt Quick. + +This page describes the concept of states, state transitions, and property +animations. It details which concepts are important and why, and how those +concepts interrelate. It also provides links to in-depth detail about the QML +types that Qt Quick provides to implement those concepts. + +\section1 States + +The state of a particular visual item is the set of information which describes +how and where the individual component parts of the visual item are displayed +within it, and all the data associated with that state. Most visual items in a +user-interface will have a limited number of states, each with well-defined +properties. + +For example, an element in a list may be either selected or not, and if +selected, it may either be the currently active single selection or it may be +part of a selection group. + +Each of those states may have certain associated visual appearance (neutral, +highlighted, expanded, and so forth). + +Qt Quick provides a \c{State} element with properties which define its semantics +and can be used to trigger behavior or animations. See the documentation about +\l{qtquick-statesanimations-states.html}{Qt Quick States} for more +information. + +\section1 Transitions + +When a visual item transitions from one state to another, the appearance of +that item will change. A transition is an "edge" between two states. It may +trigger other events to occur, as other parts of the application may have +behavior which is triggered when a certain state is entered or left. + +Qt Quick provides the \c{Transition} element which has properties which define +what will occur when the application changes from one state to another. See +the documentation on +\l{qtquick-statesanimations-animations.html#transitions-during-state-changes} +{Transitions during State Changes} for more information about transitions. + +\section1 Animations + +When transitioning between states, a fluid animation can be used to aid the +user during the transition. Abrupt and unexpected changes to the visual +canvas result in a suboptimal user-experience and should be avoided. + +If an element in a list becomes selected, the color change (from neutral to +highlighted) can be animated. If the position of the element in the list is +changed, it can be moved in an fluidly animated fashion so that the eye of the +user can track the change. + +These types of animations are supported in Qt Quick through various animation +and transition elements. See the documentation on +\l{qtquick-statesanimations-animations.html} +{Animations and Transitions In Qt Quick} for information about these elements +and how to use them. + +Animations are not only related to states and transitions between states; for +example, an animation might be triggered by other events, which are not +associated with a distinct state. It is often beneficial to always animate +changes to certain properties of visual items, regardless of the cause of the +change (for example, opacity effects). + +This type of animation is supported in Qt Quick with the \c{Behavior} element +through the \tt{"Behavior on <Property>"} syntax. Please see the documentation +about +\l{qtquick-statesanimations-animations.html#default-animation-as-behaviors} +{default property animation behaviors} for more information about the Behavior +element and how to use it. + +It is important to note, however, that using default property animations +(using Behavior elements) as well as state-transition animations can sometimes +results in undefined behavior occurring. Please see the documentation about +\l{qtquick-statesanimations-behaviors.html} +{using Qt Quick Behaviors with States} for more information about this topic. + +\section1 Animated Sprites + +The concept of animated sprites is separate to the concept of animations as +used elsewhere on this page. If you want to create or use an animated image +or sprite, please see the documentation about +\l{qtquick-effects-sprites.html}{sprite animations}. + +*/ |