Merge lp:~kevin-wright-1/u1db-qt/example-development-05-march-2013-ii into lp:u1db-qt

[Kevin Wright]

Fixed some more formatting issues in example code, changed some code comments in the example code, reduced the interval value in example 2 to 5 from 500, and ensured every delegate in each example is using 'text: contents.hello'

[Cris Dywan (kalikiana)]

As discussed, I simplified the delegates. Looking brilliant!

review: Approve

=== modified file 'examples/u1db-qt-example-1.qml'
--- examples/u1db-qt-example-1.qml	2013-03-04 13:58:58 +0000
+++ examples/u1db-qt-example-1.qml	2013-03-06 10:48:20 +0000
@@ -51,7 +51,7 @@
         database: aDatabase
         docId: 'helloworld'
         create: true
-        defaults: { "hello": "world" }
+        defaults: { "hello": "Hello World!" }
     }
            
     Tabs {
@@ -60,12 +60,12 @@
 
         Tab {
             objectName: "Tab1"
-									
+
             title: i18n.tr("Hello U1Db!")
 
             page: Page {
                 id: helloPage
-											    ListView {
+               ListView {
                     width: units.gu(45)
                     height: units.gu(80)
                     
@@ -74,13 +74,20 @@
                     */                    
                     model: aDatabase
        
-       												/* A delegate will be created for each Document retrieved from the Database */
+                   /* A delegate will be created for each Document retrieved from the Database */
                     delegate: Text {
                         x: 66; y: 77
                         text: {
-                        				/*
-                        				The contents of each Document are represented by a string that can be used in on the console or text as demonstrated here.
-                        				*/
+                            /*!
+                                The object called 'contents' contains a string as demonstrated here. In this example 'hello' is our search string.
+
+                                if(contents !== undefined){
+                                    text: contents.hello
+                                }
+                                else { "" }
+
+
+                            */
                             text: contents.hello
                         }
                     }
@@ -93,4 +100,4 @@
     
      }
 
-}
\ No newline at end of file
+}

=== added file 'examples/u1db-qt-example-2.qml'
--- examples/u1db-qt-example-2.qml	1970-01-01 00:00:00 +0000
+++ examples/u1db-qt-example-2.qml	2013-03-06 10:48:20 +0000
@@ -0,0 +1,108 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Kevin Wright <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import U1db 1.0 as U1db
+import Ubuntu.Components 0.1
+
+
+MainView {
+
+    id: u1dbView
+    width: units.gu(45)
+    height: units.gu(80)
+    
+    /*!
+    
+    A Database is very simple to create. It only needs an id and a path where the file will be created. A Database is a model, which can be used by elements, such as the ListView further in this example. 
+    
+    */
+    
+    U1db.Database {
+        id: aDatabase
+        path: "aU1DbDSatabase2"
+    }
+        
+    Timer {
+    
+        property int i: 0; interval: 5; running: true; repeat: true
+        onTriggered: newDocumentObject() 
+     
+        function newDocumentObject() {
+
+           var qmlString = "import QtQuick 2.0; import U1db 1.0 as U1db; U1db.Document {id: aDcoument"+i+";database: aDatabase;docId: 'helloworld"+i+"';create: true; defaults: { 'hello': 'Hello New Document "+i+"!' }}"
+
+           Qt.createQmlObject(qmlString, u1dbView, "dynamicNewDocument"+i);
+
+            i = i+1
+         }     
+     
+    }
+    
+    Tabs {
+        id: tabs
+        anchors.fill: parent
+
+        Tab {
+            objectName: "Tab1"
+
+            title: i18n.tr("Hello U1Db!")
+
+            page: Page {
+                id: helloPage
+               ListView {
+                    width: units.gu(45)
+                    height: units.gu(80)
+                    
+                    /*
+                    Here is the reference to the Database model mentioned earlier.
+                    */                    
+                    model: aDatabase
+       
+                   /* A delegate will be created for each Document retrieved from the Database */
+                    delegate: Text {
+                        x: 66; y: 77
+                        text: {
+                            /*!
+                                The object called 'contents' contains a string as demonstrated here. In this example 'hello' is our search string.
+
+                                if(contents !== undefined){
+                                    text: contents.hello
+                                }
+                                else { "" }
+
+
+                            */
+
+                            if(contents !== undefined){
+                                text: contents.hello
+                            }
+                            else { "" }
+                        }
+                    }
+                }
+            }
+            
+            
+     }
+    
+    
+     }
+
+}

=== added file 'examples/u1db-qt-example-3.qml'
--- examples/u1db-qt-example-3.qml	1970-01-01 00:00:00 +0000
+++ examples/u1db-qt-example-3.qml	2013-03-06 10:48:20 +0000
@@ -0,0 +1,227 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Kevin Wright <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import U1db 1.0 as U1db
+import Ubuntu.Components 0.1
+
+Item {
+
+        width: units.gu(45)
+        height: units.gu(80)
+
+    MainView {
+
+        id: u1dbView
+        width: units.gu(45)
+        height: units.gu(80)
+        anchors.top: parent.top;
+
+        /*!
+
+            A Database is very simple to create. It only needs an id and a path where the file will be created. A Database is a model, which can be used by elements, such as the ListView further in this example.
+
+            U1db.Database {
+                id: aDatabase
+                path: "aU1DbDSatabase2"
+            }
+
+        */
+
+        U1db.Database {
+            id: aDatabase
+            path: "aU1DbDSatabase2"
+        }
+
+        /*!
+
+            A Document can be declared at runtime. It requires at the very least a unique 'docId', but that alone won't do anything special. In order for a document to be entered into the database the below snippet demonstrates the basic requirements. The id might be optional.
+
+            U1db.Document {
+            id: aDocument
+            database: aDatabase
+            docId: 'helloworld'
+            create: true
+            defaults: { "hello":"Hello World" }
+            }
+
+        */
+
+       U1db.Document {
+        id: aDocument
+        database: aDatabase
+        docId: 'helloworld'
+        create: true
+        defaults: { "hello":"Hello World" }
+        }
+
+        Tabs {
+            id: tabs
+            anchors.fill: parent
+
+            Tab {
+                objectName: "Tab1"
+
+                title: i18n.tr("Hello U1Db!")
+
+                page: Page {
+
+                    id: helloPage
+
+                    Rectangle {
+
+                         width: units.gu(45)
+                         height: units.gu(70)
+                         anchors.bottom: parent.bottom
+
+                         color: "#00FFFFFF"
+
+                         ListView {
+
+                            width: units.gu(45)
+                            height: units.gu(60)
+                            anchors.bottom: parent.bottom
+
+                            TextArea{
+
+                                x: units.gu(1)
+                                y: units.gu(1)
+                                width: units.gu(43)
+                                height: units.gu(58)
+
+                                color: "#FFFFFF"
+
+                            }
+
+                         }
+
+                         Rectangle {
+
+                              width: units.gu(43)
+                              height: units.gu(5)
+                              anchors.top: addressBar.bottom
+                              x: units.gu(1.5)
+
+                              color: "#00FFFFFF"
+
+                              Row{
+
+                                 width: units.gu(43)
+                                 height: units.gu(5)
+                                 anchors.verticalCenter: parent.verticalCenter
+                                 spacing: units.gu(2)
+
+
+                                 Button {
+                                 text: "<"
+                                 onClicked: print("clicked Back Button")
+                                 }
+                                 Button {
+                                 text: "Home"
+                                 onClicked: print("clicked Home Button")
+                                 }
+                                 Button {
+                                 text: "+"
+                                 onClicked: print("clicked Save Button")
+                                 }
+                                 Button {
+                                 text: ">"
+                                 onClicked: print("clicked Forward Button")
+                                 }
+                              }
+
+                          }
+
+                       ListView {
+
+                            width: units.gu(45)
+                            height: units.gu(5)
+                            anchors.top: parent.top
+
+                            id: addressBar
+
+                            /*! Inside this example ListView is a reference to the Database model mentioned earlier:
+
+                                ListView {
+
+                                     model: aDatabase
+
+                                 }
+
+                            */
+
+                            model: aDatabase
+
+                           /*!
+
+                               Once a model is assigned to a ListView a delegate can represent each Document retrieved from the Database.
+
+                                ListView {
+
+                                     model: aDatabase
+
+                                     delegate: Rectangle{
+                                         anchors.right: parent.right
+                                     }
+
+                                 }
+
+
+                           */
+
+                            delegate: TextField {
+                                    width: units.gu(43)
+                                    anchors.verticalCenter: parent.verticalCenter
+                                    x: units.gu(1)
+
+                                    text: {
+                                        /*!
+                                            The object called 'contents' contains a string as demonstrated here. In this example 'hello' is our search string.
+
+                                            if(contents !== undefined){
+                                                text: contents.hello
+                                            }
+                                            else { "" }
+
+
+                                        */
+
+                                        if(contents !== undefined){
+                                            text: contents.hello
+                                        }
+                                        else { "" }
+                                    }
+
+                                }
+
+
+                        }
+
+                    }
+
+
+                }
+
+            }
+
+        }
+
+    }
+
+}