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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>navit: object_func Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">navit
 <span id="projectnumber">0.5.3-trunk</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structobject__func.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">object_func Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Basic functions for Navit objects.
<a href="structobject__func.html#details">More...</a></p>
<p><code>#include <<a class="el" href="xmlconfig_8h_source.html">xmlconfig.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a80a4325200821f691624c3a59f45eee0"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="attr_8h.html#a9a9ab3c12bda86add06f89976f36f98c">attr_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a80a4325200821f691624c3a59f45eee0">type</a></td></tr>
<tr class="separator:a80a4325200821f691624c3a59f45eee0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a2c233d8835f819fe1304b8c7b64a4d"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a1a2c233d8835f819fe1304b8c7b64a4d">create</a> )(struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structparent.html">parent</a>, struct <a class="el" href="structattr.html">attr</a> **attrs)</td></tr>
<tr class="separator:a1a2c233d8835f819fe1304b8c7b64a4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f54842bb47555e51e1153989e8cad13"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a2f54842bb47555e51e1153989e8cad13">get_attr</a> )(void *, enum <a class="el" href="attr_8h.html#a9a9ab3c12bda86add06f89976f36f98c">attr_type</a> <a class="el" href="structobject__func.html#a80a4325200821f691624c3a59f45eee0">type</a>, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>, struct <a class="el" href="structattr__iter.html">attr_iter</a> *iter)</td></tr>
<tr class="separator:a2f54842bb47555e51e1153989e8cad13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a747fa2c49aa96f729b59c892a26c3415"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structattr__iter.html">attr_iter</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a747fa2c49aa96f729b59c892a26c3415">iter_new</a> )(void *)</td></tr>
<tr class="separator:a747fa2c49aa96f729b59c892a26c3415"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a7b63cc58f1fa31192914eb053a34a7"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a0a7b63cc58f1fa31192914eb053a34a7">iter_destroy</a> )(struct <a class="el" href="structattr__iter.html">attr_iter</a> *)</td></tr>
<tr class="separator:a0a7b63cc58f1fa31192914eb053a34a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6686b5fbde00eddaa8657faf122dfc2"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#aa6686b5fbde00eddaa8657faf122dfc2">set_attr</a> )(void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td></tr>
<tr class="separator:aa6686b5fbde00eddaa8657faf122dfc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d5c88a7211bbf8d7abc4afe17a49bb0"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a2d5c88a7211bbf8d7abc4afe17a49bb0">add_attr</a> )(void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td></tr>
<tr class="separator:a2d5c88a7211bbf8d7abc4afe17a49bb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a683753c0f7c97a6e7aaf64626ff4cf30"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a683753c0f7c97a6e7aaf64626ff4cf30">remove_attr</a> )(void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td></tr>
<tr class="separator:a683753c0f7c97a6e7aaf64626ff4cf30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaebbfc52918e057090fcae87bdec1a9a"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#aaebbfc52918e057090fcae87bdec1a9a">init</a> )(void *)</td></tr>
<tr class="separator:aaebbfc52918e057090fcae87bdec1a9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73719e0e917a95a41083ef1434cdc737"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a73719e0e917a95a41083ef1434cdc737">destroy</a> )(void *)</td></tr>
<tr class="separator:a73719e0e917a95a41083ef1434cdc737"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a307e7b286d68e657d1dbbaa0cd0380d3"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a307e7b286d68e657d1dbbaa0cd0380d3">dup</a> )(void *)</td></tr>
<tr class="separator:a307e7b286d68e657d1dbbaa0cd0380d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42b25b3029bd3ce475cf0f0f8e6944c6"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#a42b25b3029bd3ce475cf0f0f8e6944c6">ref</a> )(void *)</td></tr>
<tr class="separator:a42b25b3029bd3ce475cf0f0f8e6944c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5a7564af1c78afdc6b2dd411950f3dc"><td class="memItemLeft" align="right" valign="top">void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structobject__func.html#ab5a7564af1c78afdc6b2dd411950f3dc">unref</a> )(void *)</td></tr>
<tr class="separator:ab5a7564af1c78afdc6b2dd411950f3dc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic functions for Navit objects. </p>
<p>This is the minimal list of functions which is supported by every Navit object.</p>
<p>Some members can be NULL for certain object types: while Navit does not mandate this function to be implemented for every object class, the function may need to be defined for some object classes.</p>
<p>Default implementations are available for every function in the list except <code>create</code>, <code>init</code> and <code>dup</code>. These can be set directly, or type-specific implementations can call through to them as they see fit. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2d5c88a7211bbf8d7abc4afe17a49bb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5c88a7211bbf8d7abc4afe17a49bb0">◆ </a></span>add_attr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* object_func::add_attr) (void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to add an attribute, set to <code>navit_object_add_attr</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#ac5bc84a6e4a20108b6495ec0ff49ec0e">command_object_add_attr()</a>, <a class="el" href="command_8c.html#ad74e35474194efd8d81d847c26ea6573">command_register_callbacks()</a>, and <a class="el" href="gui__internal__html_8c.html#a18c18878d98b084ae858628c645dbfbf">gui_internal_set_refresh_callback()</a>.</p>
</div>
</div>
<a id="a1a2c233d8835f819fe1304b8c7b64a4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a2c233d8835f819fe1304b8c7b64a4d">◆ </a></span>create</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* object_func::create) (struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structparent.html">parent</a>, struct <a class="el" href="structattr.html">attr</a> **attrs)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to create a new object instance </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a92bea054d37b06e01ea145c2cb5e152a">command_call_function()</a>.</p>
</div>
</div>
<a id="a73719e0e917a95a41083ef1434cdc737"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73719e0e917a95a41083ef1434cdc737">◆ </a></span>destroy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* object_func::destroy) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to destroy an object instance, set to <code>navit_object_destroy</code> for default behavior, can be NULL </p>
</div>
</div>
<a id="a307e7b286d68e657d1dbbaa0cd0380d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a307e7b286d68e657d1dbbaa0cd0380d3">◆ </a></span>dup</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* object_func::dup) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to create a copy of an object instance </p>
</div>
</div>
<a id="a2f54842bb47555e51e1153989e8cad13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f54842bb47555e51e1153989e8cad13">◆ </a></span>get_attr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* object_func::get_attr) (void *, enum <a class="el" href="attr_8h.html#a9a9ab3c12bda86add06f89976f36f98c">attr_type</a> <a class="el" href="structobject__func.html#a80a4325200821f691624c3a59f45eee0">type</a>, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>, struct <a class="el" href="structattr__iter.html">attr_iter</a> *iter)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to get an attribute of the object, set to <code>navit_object_get_attr</code> for default behavior </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a7f5c4370a8a9caf085040a01a77f62ee">command_evaluate_single()</a>, <a class="el" href="command_8c.html#ab7a5f12a7331a1e53a4cf9c0badb0a55">command_object_get_attr()</a>, and <a class="el" href="command_8c.html#a3a2559c11fb73b64ff63c27dcb1408fd">eval_postfix()</a>.</p>
</div>
</div>
<a id="aaebbfc52918e057090fcae87bdec1a9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaebbfc52918e057090fcae87bdec1a9a">◆ </a></span>init</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* object_func::init) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="xmlconfig_8c.html#ac5415759e6e9fededa9eee0593bc46c3">end_element()</a>.</p>
</div>
</div>
<a id="a0a7b63cc58f1fa31192914eb053a34a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a7b63cc58f1fa31192914eb053a34a7">◆ </a></span>iter_destroy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* object_func::iter_destroy) (struct <a class="el" href="structattr__iter.html">attr_iter</a> *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to destroy an attribute iterator, set to <code>navit_object_attr_iter_destroy</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a7f5c4370a8a9caf085040a01a77f62ee">command_evaluate_single()</a>, and <a class="el" href="command_8c.html#a3a2559c11fb73b64ff63c27dcb1408fd">eval_postfix()</a>.</p>
</div>
</div>
<a id="a747fa2c49aa96f729b59c892a26c3415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a747fa2c49aa96f729b59c892a26c3415">◆ </a></span>iter_new</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structattr__iter.html">attr_iter</a>*(* object_func::iter_new) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to obtain a new attribute iterator, set to <code>navit_object_attr_iter_new</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a7f5c4370a8a9caf085040a01a77f62ee">command_evaluate_single()</a>, and <a class="el" href="command_8c.html#a3a2559c11fb73b64ff63c27dcb1408fd">eval_postfix()</a>.</p>
</div>
</div>
<a id="a42b25b3029bd3ce475cf0f0f8e6944c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42b25b3029bd3ce475cf0f0f8e6944c6">◆ </a></span>ref</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* object_func::ref) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to increase the reference count for an object instance, set to <code>navit_object_ref</code> for default behavior, can be NULL for some object types </p>
</div>
</div>
<a id="a683753c0f7c97a6e7aaf64626ff4cf30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a683753c0f7c97a6e7aaf64626ff4cf30">◆ </a></span>remove_attr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* object_func::remove_attr) (void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to remove an attribute, set to <code>navit_object_remove_attr</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a3e2d390f19ae5c06ade7548e59c571d6">command_object_remove_attr()</a>, <a class="el" href="command_8c.html#abf194bbbb304b98c83c8512356623db9">command_saved_callbacks_changed()</a>, and <a class="el" href="gui__internal__menu_8h.html#ae7c141fe9ab1a1400973aff99b6103e6">gui_internal_menu_destroy()</a>.</p>
</div>
</div>
<a id="aa6686b5fbde00eddaa8657faf122dfc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6686b5fbde00eddaa8657faf122dfc2">◆ </a></span>set_attr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* object_func::set_attr) (void *, struct <a class="el" href="structattr.html">attr</a> *<a class="el" href="structattr.html">attr</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to set an attribute, set to <code>navit_object_set_attr</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="command_8c.html#a68a6b8f43887962ab9374cf8abc9b03a">command_set_attr()</a>.</p>
</div>
</div>
<a id="a80a4325200821f691624c3a59f45eee0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80a4325200821f691624c3a59f45eee0">◆ </a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="attr_8h.html#a9a9ab3c12bda86add06f89976f36f98c">attr_type</a> object_func::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The object type </p>
</div>
</div>
<a id="ab5a7564af1c78afdc6b2dd411950f3dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5a7564af1c78afdc6b2dd411950f3dc">◆ </a></span>unref</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void*(* object_func::unref) (void *)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to decrease the reference count for an object instance, set to <code>navit_object_unref</code> for default behavior, can be NULL for some object types </p>
<p class="reference">Referenced by <a class="el" href="xmlconfig_8c.html#ac5415759e6e9fededa9eee0593bc46c3">end_element()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="xmlconfig_8h_source.html">xmlconfig.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structobject__func.html">object_func</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
