File: scripting.html

package info (click to toggle)
qdjango 0.2.5-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,144 kB
  • sloc: cpp: 6,085; perl: 104; makefile: 6
file content (137 lines) | stat: -rw-r--r-- 7,286 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>QDjango: Scripting models</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">QDjango
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">Scripting models </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The <a class="el" href="classQDjangoScript.html" title="The QDjangoScript class provides static methods for making models scriptable.">QDjangoScript</a> class makes it easy to access your models from <a href="http://doc.qt.nokia.com/latest/qtscript.html">QtScript</a>.</p>
<h2><a class="anchor" id="making-scriptable"></a>
Making your models scriptable</h2>
<p>You can register a model with a <a href="http://doc.qt.nokia.com/latest/qscriptengine.html">QScriptEngine</a> instance as follows:</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor">#include &lt;QDjangoQuerySet.h&gt;</span>
<span class="preprocessor">#include &lt;QDjangoScript.h&gt;</span>

Q_DECLARE_METATYPE(<a class="code" href="classQDjangoQuerySet.html" title="The QDjangoQuerySet class is a template class for performing database queries.">QDjangoQuerySet&lt;User&gt;</a>)

QScriptEngine *engine = new QScriptEngine;
<a class="code" href="classQDjangoScript.html" title="The QDjangoScript class provides static methods for making models scriptable.">QDjangoScript</a>::registerWhere(engine);
<a class="code" href="classQDjangoScript.html" title="The QDjangoScript class provides static methods for making models scriptable.">QDjangoScript</a>::registerModel&lt;User&gt;(engine);
</pre></div><h2><a class="anchor" id="scripting-models"></a>
Using your models from a script</h2>
<p>Because <a class="el" href="classQDjango.html" title="The QDjango class provides a set of static functions.">QDjango</a> makes use of Qt's property system, all model fields can automatically be accessed from <a href="http://doc.qt.nokia.com/latest/qtscript.html">QtScript</a>. For instance if you declared a <code>User</code> model, you can run the following code:</p>
<div class="fragment"><pre class="fragment"><span class="comment">// create a user instance and save it to database</span>
user = <span class="keyword">new</span> User();
user.username = <span class="stringliteral">&quot;someuser&quot;</span>;
user.password = <span class="stringliteral">&quot;somepassword&quot;</span>;
user.save();

<span class="comment">// remove the user from database</span>
user.remove();
</pre></div><p>You can also perform database queries:</p>
<div class="fragment"><pre class="fragment"><span class="comment">// filter users whose username is &quot;foouser&quot; and password is &quot;foopass&quot;</span>
qs = User.objects.filter({<span class="stringliteral">&#39;username&#39;</span>: <span class="stringliteral">&#39;foouser&#39;</span>, <span class="stringliteral">&#39;password&#39;</span>: <span class="stringliteral">&#39;foopass&#39;</span>});

<span class="comment">// iterate over the results</span>
<span class="keywordflow">for</span> (var i = 0; i &lt; qs.size(); i++) {
  user = qs.at(i);
  print(<span class="stringliteral">&quot;found &quot;</span> + user.username);
}

<span class="comment">// remove all matching users from database</span>
qs.remove();
</pre></div> </div></div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2012 18:11:23 for QDjango by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>