Add docs on using a query in XMLRole with the less obvious boolean()
[qt:qtdeclarative.git] / src / quick / doc / snippets / qml / xmlrole.qml
1 /****************************************************************************
2 **
3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the documentation 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 Digia Plc and its Subsidiary(-ies) nor the names
21 **     of its contributors may be used to endorse or promote products derived
22 **     from this software without specific prior written permission.
23 **
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 import QtQuick.XmlListModel 2.0
43
44 Rectangle {
45     width: 300; height: 200
46
47 //![0]
48 XmlListModel {
49     id: model
50 //![0]
51     source: "xmlrole.xml"
52
53 //![1]
54     // XmlRole queries will be made on <book> elements
55     query: "/catalogue/book"
56
57     // query the book title
58     XmlRole { name: "title"; query: "title/string()" }
59
60     // query the book's year
61     XmlRole { name: "year"; query: "year/number()" }
62
63     // query the book's type (the '@' indicates 'type' is an attribute, not an element)
64     XmlRole { name: "type"; query: "@type/string()" }
65
66     // query the book's first listed author (note in XPath the first index is 1, not 0)
67     XmlRole { name: "first_author"; query: "author[1]/string()" }
68
69     // query the wanted attribute as a boolean
70     XmlRole { name: "wanted"; query: "boolean(@wanted)" }
71 }
72 //![1]
73
74 ListView {
75     width: 300; height: 200
76     model: model
77     delegate: Column {
78         Text { text: title + " (" + type + ")"; font.bold: true }
79         Text { text: first_author }
80         Text { text: year }
81     }
82 }
83
84 }