File: struct__QofParam.html

package info (click to toggle)
qof 0.5.0-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,376 kB
  • ctags: 2,995
  • sloc: ansic: 14,210; sh: 7,273; makefile: 204; yacc: 184; lex: 123
file content (44 lines) | stat: -rw-r--r-- 3,493 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>QOF: _QofParam struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6-20040222 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>_QofParam Struct Reference<br>
<small>
[<a class="el" href="group__Class.html">Class</a>]</small>
</h1><code>#include &lt;qofclass.h&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This structure is for each queriable parameter in an object<p>
-- param_name is the name of the parameter. -- param_type is the type of the parameter, which can be either another object (QofIdType) or it can be a core data type (QofType). -- param_getfcn is the function to actually obtain the parameter -- param_setfcn is the function to actually set the parameter -- param_userdata is a place where the user can place any desiered user-defined data (and thus can be used by the user-defined setter/getter).<p>
Either the getter or the setter may be NULL.<p>
XXX todo/fixme: need to define a destroy callback, so that when the param memory is freed, the callback can be used to release the user-defined data. 
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="_QofParam::param_name" ></a>
const char *&nbsp;</td><td class="memItemRight" valign=bottom><b>param_name</b></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o1" doxytag="_QofParam::param_type" ></a>
<a class="el" href="group__Class.html#ga0">QofType</a>&nbsp;</td><td class="memItemRight" valign=bottom><b>param_type</b></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o2" doxytag="_QofParam::param_getfcn" ></a>
<a class="el" href="group__Class.html#ga2">QofAccessFunc</a>&nbsp;</td><td class="memItemRight" valign=bottom><b>param_getfcn</b></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o3" doxytag="_QofParam::param_setfcn" ></a>
<a class="el" href="group__Class.html#ga3">QofSetterFunc</a>&nbsp;</td><td class="memItemRight" valign=bottom><b>param_setfcn</b></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o4" doxytag="_QofParam::param_userdata" ></a>
gpointer&nbsp;</td><td class="memItemRight" valign=bottom><b>param_userdata</b></td></tr>

</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qofclass_8h.html">qofclass.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun May 23 15:41:47 2004 for QOF by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6-20040222 </small></address>
</body>
</html>