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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<!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: QDjangoMetaModel Class Reference</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 Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">QDjangoMetaModel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QDjangoMetaModel" -->
<p>The <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a> class holds the database schema for a model.
<a href="classQDjangoMetaModel.html#details">More...</a></p>
<p><code>#include <<a class="el" href="QDjangoMetaModel_8h_source.html">QDjangoMetaModel.h</a>></code></p>
<p><a href="classQDjangoMetaModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a305896ccf84170cfeb72a6d5eb880b"></a><!-- doxytag: member="QDjangoMetaModel::QDjangoMetaModel" ref="a8a305896ccf84170cfeb72a6d5eb880b" args="(const QObject *model=0)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a8a305896ccf84170cfeb72a6d5eb880b">QDjangoMetaModel</a> (const QObject *model=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a> by inspecting the given <em>model</em> instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c072d0d1dac763fb748a30adee36703"></a><!-- doxytag: member="QDjangoMetaModel::QDjangoMetaModel" ref="a1c072d0d1dac763fb748a30adee36703" args="(const QDjangoMetaModel &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a1c072d0d1dac763fb748a30adee36703">QDjangoMetaModel</a> (const <a class="el" href="classQDjangoMetaModel.html">QDjangoMetaModel</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a copy of <em>other</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0377fb890378d4c715a717dddecd05f5"></a><!-- doxytag: member="QDjangoMetaModel::~QDjangoMetaModel" ref="a0377fb890378d4c715a717dddecd05f5" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a0377fb890378d4c715a717dddecd05f5">~QDjangoMetaModel</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the meta model. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70b5ba3605906d98346d42fcb03f5101"></a><!-- doxytag: member="QDjangoMetaModel::operator=" ref="a70b5ba3605906d98346d42fcb03f5101" args="(const QDjangoMetaModel &other)" -->
<a class="el" href="classQDjangoMetaModel.html">QDjangoMetaModel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a70b5ba3605906d98346d42fcb03f5101">operator=</a> (const <a class="el" href="classQDjangoMetaModel.html">QDjangoMetaModel</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assigns <em>other</em> to this meta model. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74cac06c7bfa638042cf1ad3d81b2f7c"></a><!-- doxytag: member="QDjangoMetaModel::createTable" ref="a74cac06c7bfa638042cf1ad3d81b2f7c" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a74cac06c7bfa638042cf1ad3d81b2f7c">createTable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the database table for this <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3d2abee49df5f47d04e55c10df83abf"></a><!-- doxytag: member="QDjangoMetaModel::dropTable" ref="af3d2abee49df5f47d04e55c10df83abf" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#af3d2abee49df5f47d04e55c10df83abf">dropTable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drops the database table for this <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a754b0ae26c7019bce1a46aaf62bc0fee"></a><!-- doxytag: member="QDjangoMetaModel::load" ref="a754b0ae26c7019bce1a46aaf62bc0fee" args="(QObject *model, const QVariantList &props, int &pos) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a754b0ae26c7019bce1a46aaf62bc0fee">load</a> (QObject *model, const QVariantList &props, int &pos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the given properties into a <em>model</em> instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b0a36043675008e7114b420a73e3f62"></a><!-- doxytag: member="QDjangoMetaModel::remove" ref="a3b0a36043675008e7114b420a73e3f62" args="(QObject *model) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a3b0a36043675008e7114b420a73e3f62">remove</a> (QObject *model) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the given <em>model</em> instance from the database. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a6837d4f7f1d89327516e2e9ad39bef32">save</a> (QObject *model) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the given <em>model</em> instance to the database. <a href="#a6837d4f7f1d89327516e2e9ad39bef32"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a22062f4798b05b42d40d260160581d2d">foreignKey</a> (const QObject *model, const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the <a class="el" href="classQDjangoModel.html" title="The QDjangoModel class is the base class for all models.">QDjangoModel</a> pointed to by the given foreign-key. <a href="#a22062f4798b05b42d40d260160581d2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a603c0ccdef63152602d4bcb1b79b1a82">setForeignKey</a> (QObject *model, const char *name, QObject *value) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classQDjangoModel.html" title="The QDjangoModel class is the base class for all models.">QDjangoModel</a> pointed to by the given foreign-key. <a href="#a603c0ccdef63152602d4bcb1b79b1a82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c4746115f6af44eb23e5ee70498ef61"></a><!-- doxytag: member="QDjangoMetaModel::localField" ref="a7c4746115f6af44eb23e5ee70498ef61" args="(const QString &name) const " -->
<a class="el" href="classQDjangoMetaField.html">QDjangoMetaField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#a7c4746115f6af44eb23e5ee70498ef61">localField</a> (const QString &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the local field with the specified <em>name</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa681629f5b2c744bfb7613d2dcc7fe90"></a><!-- doxytag: member="QDjangoMetaModel::localFields" ref="aa681629f5b2c744bfb7613d2dcc7fe90" args="() const " -->
QList< <a class="el" href="classQDjangoMetaField.html">QDjangoMetaField</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#aa681629f5b2c744bfb7613d2dcc7fe90">localFields</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of local fields. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed7f39fa85e0859fec0225670d3a7b3c"></a><!-- doxytag: member="QDjangoMetaModel::foreignFields" ref="aed7f39fa85e0859fec0225670d3a7b3c" args="() const " -->
QMap< QByteArray, QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#aed7f39fa85e0859fec0225670d3a7b3c">foreignFields</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the foreign field mapping. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8e9c3859f80193ae9c4af8d990a9f80"></a><!-- doxytag: member="QDjangoMetaModel::primaryKey" ref="aa8e9c3859f80193ae9c4af8d990a9f80" args="() const " -->
QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#aa8e9c3859f80193ae9c4af8d990a9f80">primaryKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the primary key for the current <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad05a604af4863c82dbb8b6b76514fb8e"></a><!-- doxytag: member="QDjangoMetaModel::table" ref="ad05a604af4863c82dbb8b6b76514fb8e" args="() const " -->
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classQDjangoMetaModel.html#ad05a604af4863c82dbb8b6b76514fb8e">table</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the database table. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classQDjangoMetaModel.html" title="The QDjangoMetaModel class holds the database schema for a model.">QDjangoMetaModel</a> class holds the database schema for a model. </p>
<p>It manages table creation and deletion operations as well as row serialisation, deserialisation and deletion operations. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a22062f4798b05b42d40d260160581d2d"></a><!-- doxytag: member="QDjangoMetaModel::foreignKey" ref="a22062f4798b05b42d40d260160581d2d" args="(const QObject *model, const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QObject * <a class="el" href="classQDjangoMetaModel.html#a22062f4798b05b42d40d260160581d2d">QDjangoMetaModel::foreignKey</a> </td>
<td>(</td>
<td class="paramtype">const QObject * </td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieves the <a class="el" href="classQDjangoModel.html" title="The QDjangoModel class is the base class for all models.">QDjangoModel</a> pointed to by the given foreign-key. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">model</td><td></td></tr>
<tr><td class="paramname">name</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6837d4f7f1d89327516e2e9ad39bef32"></a><!-- doxytag: member="QDjangoMetaModel::save" ref="a6837d4f7f1d89327516e2e9ad39bef32" args="(QObject *model) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classQDjangoMetaModel.html#a6837d4f7f1d89327516e2e9ad39bef32">QDjangoMetaModel::save</a> </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>model</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Saves the given <em>model</em> instance to the database. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if saving succeeded, false otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a603c0ccdef63152602d4bcb1b79b1a82"></a><!-- doxytag: member="QDjangoMetaModel::setForeignKey" ref="a603c0ccdef63152602d4bcb1b79b1a82" args="(QObject *model, const char *name, QObject *value) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classQDjangoMetaModel.html#a603c0ccdef63152602d4bcb1b79b1a82">QDjangoMetaModel::setForeignKey</a> </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>model</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the <a class="el" href="classQDjangoModel.html" title="The QDjangoModel class is the base class for all models.">QDjangoModel</a> pointed to by the given foreign-key. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">model</td><td></td></tr>
<tr><td class="paramname">name</td><td></td></tr>
<tr><td class="paramname">value</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The <code>model</code> will take ownership of the given <code>value</code>. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="QDjangoMetaModel_8h_source.html">QDjangoMetaModel.h</a></li>
<li>QDjangoMetaModel.cpp</li>
</ul>
</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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  <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>
|
