improved desktop UI
[mardrone] / mardrone / imports / com / nokia / meego / Page.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the Qt Components project.
8 **
9 ** $QT_BEGIN_LICENSE:BSD$
10 ** You may use this file under the terms of the BSD license as follows:
11 **
12 ** "Redistribution and use in source and binary forms, with or without
13 ** modification, are permitted provided that the following conditions are
14 ** met:
15 **   * Redistributions of source code must retain the above copyright
16 **     notice, this list of conditions and the following disclaimer.
17 **   * Redistributions in binary form must reproduce the above copyright
18 **     notice, this list of conditions and the following disclaimer in
19 **     the documentation and/or other materials provided with the
20 **     distribution.
21 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
22 **     the names of its contributors may be used to endorse or promote
23 **     products derived from this software without specific prior written
24 **     permission.
25 **
26 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40
41 // The Page item is intended for use as a root item in QML items that make
42 // up pages to use with the PageStack.
43
44 import QtQuick 1.1
45 import "." 1.0
46 import "UIConstants.js" as UI
47
48 Item {
49     id: root
50
51     visible: false
52
53     // Note we do not use anchor fill here because it will force us to relayout
54     // hidden children when rotating the screen as well
55     width: visible && parent ? parent.width - anchors.leftMargin - anchors.rightMargin : __prevWidth
56     height: visible && parent ? parent.height  - anchors.topMargin - anchors.bottomMargin : __prevHeight
57     x: parent ? anchors.leftMargin : 0
58     y: parent ? anchors.topMargin : 0
59
60     onWidthChanged: __prevWidth = visible ? width : __prevWidth
61     onHeightChanged: __prevHeight = visible ? height : __prevHeight
62
63     property int __prevWidth: 0
64     property int __prevHeight: 0
65
66     property bool __isPage: true
67
68     anchors.margins: 0 // Page margins should generally be 16 pixels as defined by UI.MARGIN_XLARGE
69
70     // The status of the page. One of the following:
71     //      PageStatus.Inactive - the page is not visible
72     //      PageStatus.Activating - the page is transitioning into becoming the active page
73     //      PageStatus.Active - the page is the current active page
74     //      PageStatus.Deactivating - the page is transitioning into becoming inactive
75     property int status: PageStatus.Inactive
76     
77     // Defines the tools for the page; null for none.
78     property Item tools: null
79     
80     // The page stack that the page is in.
81     property PageStack pageStack
82
83     // Defines if page is locked in landscape.
84     property bool lockInLandscape: false // Deprecated
85     onLockInLandscapeChanged: console.log("warning: Page.lockInLandscape is deprecated, use Page.orientationLock")
86
87     // Defines if page is locked in portrait.
88     property bool lockInPortrait: false // Deprecated
89     onLockInPortraitChanged: console.log("warning: Page.lockInPortrait is deprecated, use Page.orientationLock")
90
91     // Defines orientation lock for a page
92     property int orientationLock: PageOrientation.Automatic
93
94     onStatusChanged: {
95         if (status == PageStatus.Activating) {
96             __updateOrientationLock()
97         }
98     }
99
100     onOrientationLockChanged: {
101         __updateOrientationLock()
102     }
103
104     function __updateOrientationLock() {
105         switch (orientationLock) {
106         case PageOrientation.Automatic:
107             screen.setAllowedOrientations(Screen.Portrait | Screen.Landscape);
108             break
109         case PageOrientation.LockPortrait:
110             screen.setAllowedOrientations(Screen.Portrait);
111             break
112         case PageOrientation.LockLandscape:
113             screen.setAllowedOrientations(Screen.Landscape);
114             break
115         case PageOrientation.LockPrevious:
116             // Allowed orientation should be changed to current
117             // if previously it was locked, it will remain locked
118             // if previously it was not locked, it will be locked to current
119             screen.setAllowedOrientations(screen.currentOrientation);
120             break
121         }
122     }
123 }
124