examples/tutorials/gettingStartedQml/parts/part3/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 import QtQuick 2.0
  42
  43 Rectangle {
  44
  45     //identifier of the item
  46     id: button
  47
  48     property string label: "button label"
  49
  50     //these properties act as constants, useable outside this QML file
  51     property int buttonHeight: 75
  52     property int buttonWidth: 150
  53
  54     //the color highlight when the mouse hovers on the rectangle
  55     property color onHoverColor: "gold"
  56     property color borderColor: "white"
  57
  58     //buttonColor is set to the button's main color
  59     property color buttonColor: "lightblue"
  60
  61     //set appearance properties
  62     radius:10
  63     smooth: true
  64     border{color: "white"; width: 3}
  65     width: buttonWidth; height: buttonHeight
  66
  67     Text{
  68         id: buttonLabel
  69         anchors.centerIn: parent
  70         text: label
  71     }
  72
  73     //buttonClick() is callable and a signal handler, onButtonClick is automatically created
  74     signal buttonClick()
  75     onButtonClick: {
  76         console.log(buttonLabel.text + " clicked" )
  77     }
  78
  79     //define the clickable area to be the whole rectangle
  80     MouseArea{
  81         id: buttonMouseArea
  82         anchors.fill: parent    //stretch the area to the parent's dimension
  83         onClicked: buttonClick()
  84
  85         //if true, then onEntered and onExited called if mouse hovers in the mouse area
  86                 //if false, a button must be clicked to detect the mouse hover
  87                 hoverEnabled: true
  88
  89                 //display a border if the mouse hovers on the button mouse area
  90                 onEntered: parent.border.color = onHoverColor
  91                 //remove the border if the mouse exits the button mouse area
  92                 onExited:  parent.border.color = borderColor
  93
  94     }
  95
  96     //change the color of the button when pressed
  97     color: buttonMouseArea.pressed ? Qt.darker(buttonColor, 1.5) : buttonColor
  98
  99 }