ProgressBar.qml Example File

componentset/ProgressBar.qml

  /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the examples of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** 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 The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** BSD License Usage
  ** Alternatively, you may use this file under the terms of the BSD license
  ** as follows:
  **
  ** "Redistribution and use in source and binary forms, with or without
  ** modification, are permitted provided that the following conditions are
  ** met:
  **   * Redistributions of source code must retain the above copyright
  **     notice, this list of conditions and the following disclaimer.
  **   * Redistributions in binary form must reproduce the above copyright
  **     notice, this list of conditions and the following disclaimer in
  **     the documentation and/or other materials provided with the
  **     distribution.
  **   * Neither the name of The Qt Company Ltd nor the names of its
  **     contributors may be used to endorse or promote products derived
  **     from this software without specific prior written permission.
  **
  **
  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/

  import QtQuick 1.0

  /*!
      \qmltype ProgressBar
      \inqmlmodule UIComponents
      \brief A component that shows the progress of an event

      A ProgressBar shows the linear progress of an event as its \l value.
      The range is specified using the \l {minimum} and the \l{maximum} values.

      The ProgressBar component is part of the \l {UI Components} module.

      This documentation is part of the \l{componentset}{UIComponents} example.
  */
  Item {
      id: progressbar

      /*!
          The minimum value of the ProgressBar range.
          The \l value must not be less than this value.
      */
      property int minimum: 0

      /*!
          The maximum value of the ProgressBar range.
          The \l value must not be more than this value.
      */
      property int maximum: 100

      /*!
          The value of the progress.
      */
      property int value: 0

      /*!
         \qmlproperty color ProgressBar::color
         The color of the ProgressBar's gradient. Must bind to a color type.

         \omit
             The "\qmlproperty <type> <property name>" is needed because
             property alias need to have their types manually entered.

             QDoc will not publish the documentation within omit and endomit.
         \endomit

         \sa secondColor
      */
      property alias color: gradient1.color

      /*!
         \qmlproperty color ProgressBar::secondColor
         The second color of the ProgressBar's gradient.
         Must bind to a color type.

         \omit
             The "\qmlproperty <type> <property name>" is needed because
             property alias need to have their types manually entered.

             QDoc will not publish the documentation within omit and endomit.
         \endomit

          \sa color
      */
      property alias secondColor: gradient2.color

      width: 250; height: 23
      clip: true

      Rectangle {
          id: highlight

          /*!
              An internal documentation comment. The widthDest property is not
              a public API and therefore will not be exposed.
          */
          property int widthDest: ((progressbar.width * (value - minimum)) / (maximum - minimum) - 6)

          width: highlight.widthDest
          Behavior on width { SmoothedAnimation { velocity: 1200 } }

          anchors { left: parent.left; top: parent.top; bottom: parent.bottom; margins: 3 }
          radius: 1
          gradient: Gradient {
              GradientStop { id: gradient1; position: 0.0 }
              GradientStop { id: gradient2; position: 1.0 }
          }

      }
      Text {
          anchors { right: highlight.right; rightMargin: 6; verticalCenter: parent.verticalCenter }
          color: "white"
          font.bold: true
          text: Math.floor((value - minimum) / (maximum - minimum) * 100) + '%'
      }
  }