summaryrefslogtreecommitdiff
path: root/src/controls/qquickstack.cpp
blob: 1723ef72dd7a6cfe6f7e0e9d5a21061ab9c55fcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Quick Controls module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qquickstack_p.h"

QT_BEGIN_NAMESPACE

/*!
    \qmltype Stack
    \instantiates QQuickStack
    \inqmlmodule QtQuick.Controls 1.0
    \ingroup views
    \brief Provides attached properties for items pushed onto a StackView.

    The Stack attached property provides information when an item becomes
    active or inactive through the \l{Stack::status}{Stack.status} property.
    Status will be \c Stack.Activating when an item is transitioning into
    being the current item on the screen, and \c Stack.Active once the
    transition stops. When it leaves the screen, it will be
    \c Stack.Deactivating, and then \c Stack.Inactive.

    \sa StackView
*/

QQuickStack::QQuickStack(QObject *object)
    : QObject(object),
      m_index(-1),
      m_status(Inactive),
      m_pageStack(0)
{
}

QQuickStack *QQuickStack::qmlAttachedProperties(QObject *object)
{
    return new QQuickStack(object);
}

/*!
    \readonly
    \qmlproperty int Stack::index

    This property holds the index of the item inside \l{pageStack}{StackView},
    so that \l{StackView::get()}{pageStack.get(index)} will return the item itself.
    If \l{Stack::pageStack}{pageStack} is \c null, \a index will be \c -1.
*/
int QQuickStack::index() const
{
    return m_index;
}

void QQuickStack::setIndex(int index)
{
    if (m_index != index) {
        m_index = index;
        emit indexChanged();
    }
}

/*!
    \readonly
    \qmlproperty enumeration Stack::status

    This property holds the status of the item. It can have one of the following values:
    \list
    \li \c Stack.Inactive: the item is not visible
    \li \c Stack.Activating: the item is transitioning into becoming an active item on the stack
    \li \c Stack.Active: the item is on top of the stack
    \li \c Stack.Deactivating: the item is transitioning into becoming inactive
    \endlist
*/
QQuickStack::Status QQuickStack::status() const
{
    return m_status;
}

void QQuickStack::setStatus(Status status)
{
    if (m_status != status) {
        m_status = status;
        emit statusChanged();
    }
}

/*!
    \readonly
    \qmlproperty StackView Stack::pageStack

    This property holds the StackView the item is in. If the item is not inside
    a StackView, \a pageStack will be \c null.
*/
QQuickItem *QQuickStack::pageStack() const
{
    return m_pageStack;
}

void QQuickStack::setStackView(QQuickItem *pageStack)
{
    if (m_pageStack != pageStack) {
        m_pageStack = pageStack;
        emit pageStackChanged();
    }
}

QT_END_NAMESPACE