Remove "All rights reserved" line from license headers.
[profile/ivi/qtdeclarative.git] / examples / tutorials / gettingStartedQml / core / Button.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
5 **
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** You may use this file under the terms of the BSD license as follows:
10 **
11 ** "Redistribution and use in source and binary forms, with or without
12 ** modification, are permitted provided that the following conditions are
13 ** met:
14 **   * Redistributions of source code must retain the above copyright
15 **     notice, this list of conditions and the following disclaimer.
16 **   * Redistributions in binary form must reproduce the above copyright
17 **     notice, this list of conditions and the following disclaimer in
18 **     the documentation and/or other materials provided with the
19 **     distribution.
20 **   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
21 **     the names of its contributors may be used to endorse or promote
22 **     products derived from this software without specific prior written
23 **     permission.
24 **
25 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40
41
42 import QtQuick 2.0
43
44 Rectangle {
45     //identifier of the item
46     id: button
47
48     //these properties act as constants, useable outside this QML file
49     property int buttonHeight: 75
50     property int buttonWidth: 150
51
52     //attaches to the Text element's text content
53     property string label
54     property color textColor: buttonLabel.color
55
56     //the color highlight when the mouse hovers on the rectangle
57     property color onHoverColor: "lightsteelblue"
58     property color borderColor: "transparent"
59
60     //buttonColor is set to the button's main color
61     property color buttonColor: "lightblue"
62
63     property real labelSize: 14
64
65     //set appearance properties
66     radius: 6
67     smooth: true
68     border { width: 2; color: borderColor }
69     width: buttonWidth; height: buttonHeight
70
71     Text {
72         id: buttonLabel
73         anchors.centerIn: parent
74         text: label     //bind the text to the parent's text
75         color: "#DCDCCC"
76         font.pointSize: labelSize
77     }
78
79     //buttonClick() is callable and a signal handler, onButtonClick is automatically created
80     signal buttonClick()
81
82     //define the clickable area to be the whole rectangle
83     MouseArea { 
84         id: buttonMouseArea
85         anchors.fill: parent    //stretch the area to the parent's dimension
86         onClicked: buttonClick()
87
88         //if true, then onEntered and onExited called if mouse hovers in the mouse area
89         //if false, a button must be clicked to detect the mouse hover
90         hoverEnabled: true
91
92         //display a border if the mouse hovers on the button mouse area
93         onEntered: parent.border.color = onHoverColor
94         //remove the border if the mouse exits the button mouse area
95         onExited:  parent.border.color = borderColor
96     }
97
98     //change the color of the button when pressed
99     color: buttonMouseArea.pressed ? Qt.darker(buttonColor, 1.5) : buttonColor
100     //animate the color whenever the color property changes
101     Behavior on color { ColorAnimation{ duration: 55 } }
102
103     //scale the button when pressed
104     scale: buttonMouseArea.pressed ? 1.1 : 1.00
105     //Animate the scale property change
106     Behavior on scale { NumberAnimation{ duration: 55 } }
107
108 }