vcs.maemo.org Git - mardrone/blob - mardrone/imports/com/meego/extras/PageIndicator.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 import QtQuick 1.1
  42 import com.nokia.meego 1.0
  43
  44 /*
  45    Class: PageIndicator
  46    Component to indicate the page user is currently viewing.
  47
  48    A page indicator is a component that shows the number of availabe pages as well as the page the user is
  49    currently on.  The user can also specify the display type to select the normal/inverted visual.
  50 */
  51 ImplicitSizeItem {
  52     id: root
  53
  54     /*
  55      * Property: totalPages
  56      * [int] The total number of pages.  This value should be larger than 0.
  57      */
  58     property int totalPages: 0
  59
  60     /*
  61      * Property: currentPage
  62      * [int] The current page the user is on.  This value should be larger than 0.
  63      */
  64     property int currentPage: 0
  65
  66     /*
  67      * Property: inverted
  68      * [bool] Specify whether the visual for the rating indicator uses the inverted color.  The value is
  69      * false for use with a light background and true for use with a dark background.
  70      */
  71     property bool inverted: theme.inverted
  72
  73     implicitWidth: currentImage.width * totalPages + (totalPages - 1) * internal.spacing
  74     implicitHeight: currentImage.height
  75
  76     /* private */
  77     QtObject {
  78         id: internal
  79
  80         property int spacing: 8
  81
  82         property string totalPagesImageSource: inverted ?
  83                                                  "image://theme/meegotouch-inverted-pageindicator-page" :
  84                                                  "image://theme/meegotouch-pageindicator-page"
  85         property string currentPageImageSource: inverted ?
  86                                                   "image://theme/meegotouch-inverted-pageindicator-page-current" :
  87                                                   "image://theme/meegotouch-pageindicator-page-current"
  88
  89         property bool init: true
  90
  91
  92         function updateUI() {
  93
  94             if(totalPages <=0) {
  95                 totalPages = 1;
  96                 currentPage = 1;
  97             } else {
  98                 if(currentPage <=0)
  99                     currentPage = 1;
 100                 if(currentPage > totalPages)
 101                     currentPage = totalPages;
 102             }
 103
 104             frontRepeater.model = currentPage - 1;
 105             backRepeater.model = totalPages - currentPage;
 106         }
 107     }
 108
 109     Component.onCompleted: {
 110         internal.updateUI();
 111         internal.init = false;
 112     }
 113
 114     onTotalPagesChanged: {
 115         if(!internal.init)
 116             internal.updateUI();
 117     }
 118
 119     onCurrentPageChanged: {
 120         if(!internal.init)
 121             internal.updateUI();
 122     }
 123
 124     Row {
 125         Repeater {
 126              id: frontRepeater
 127
 128              Item {
 129                  height: currentImage.height
 130                  width:  currentImage.width + internal.spacing
 131
 132                  Image {
 133                      source: internal.totalPagesImageSource
 134                  }
 135              }
 136          }
 137
 138          Image {
 139              id: currentImage
 140              source:  internal.currentPageImageSource
 141          }
 142
 143          Repeater {
 144              id: backRepeater
 145
 146              Item {
 147                  height: currentImage.height
 148                  width:  currentImage.width + internal.spacing
 149
 150                  Image {
 151                      source: internal.totalPagesImageSource
 152                      anchors.right: parent.right
 153                  }
 154              }
 155          }
 156     }
 157 }