Update copyright headers
[qt:qt.git] / demos / declarative / snake / qml / snake / content / HighScoreModel.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 import QtQuick 1.0
43
44 // Models a high score table.
45 //
46 // Use this component like this:
47 //
48 //  HighScoreModel {
49 //      id: highScores
50 //      game: "MyCoolGame"
51 //  }
52 //
53 // Then use either use the top-score properties:
54 //
55 //  Text { text: "HI: " + highScores.topScore }
56 //
57 // or, use the model in a view:
58 //
59 //  ListView {
60 //      model: highScore
61 //      delegate: Component {
62 //                    ... player ... score ...
63 //                }
64 //  }
65 //
66 // Add new scores via:
67 //
68 //  saveScore(newScore)
69 //
70 // or:
71 //
72 //  savePlayerScore(playerName,newScore)
73 //
74 // The best maxScore scores added by this method will be retained in an SQL database,
75 // and presented in the model and in the topScore/topPlayer properties.
76 //
77
78 ListModel {
79     id: model
80     property string game: ""
81     property int topScore: 0
82     property string topPlayer: ""
83     property int maxScores: 10
84
85     function __db()
86     {
87         return openDatabaseSync("HighScoreModel", "1.0", "Generic High Score Functionality for QML", 1000000);
88     }
89     function __ensureTables(tx)
90     {
91         tx.executeSql('CREATE TABLE IF NOT EXISTS HighScores(game TEXT, score INT, player TEXT)', []);
92     }
93
94     function fillModel() {
95         __db().transaction(
96             function(tx) {
97                 __ensureTables(tx);
98                 var rs = tx.executeSql("SELECT score,player FROM HighScores WHERE game=? ORDER BY score DESC", [game]);
99                 model.clear();
100                 if (rs.rows.length > 0) {
101                     topScore = rs.rows.item(0).score
102                     topPlayer = rs.rows.item(0).player
103                     for (var i=0; i<rs.rows.length; ++i) {
104                         if (i < maxScores)
105                             model.append(rs.rows.item(i))
106                     }
107                     if (rs.rows.length > maxScores)
108                         tx.executeSql("DELETE FROM HighScores WHERE game=? AND score <= ?",
109                                             [game, rs.rows.item(maxScores).score]);
110                 }
111             }
112         )
113     }
114
115     function savePlayerScore(player,score) {
116         __db().transaction(
117             function(tx) {
118                 __ensureTables(tx);
119                 tx.executeSql("INSERT INTO HighScores VALUES(?,?,?)", [game,score,player]);
120                 fillModel();
121             }
122         )
123     }
124
125     function saveScore(score) {
126         savePlayerScore("player",score);
127     }
128
129     function clearScores() {
130         __db().transaction(
131             function(tx) {
132                 tx.executeSql("DELETE FROM HighScores WHERE game=?", [game]);
133                 fillModel();
134             }
135         )
136     }
137
138     Component.onCompleted: { fillModel() }
139 }