File: TomoeCandidate.html

package info (click to toggle)
tomoe 0.6.0-1.3
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 51,396 kB
  • sloc: xml: 1,387,526; ansic: 11,515; sh: 9,072; ruby: 1,344; python: 762; makefile: 450
file content (252 lines) | stat: -rw-r--r-- 9,862 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>TomoeCandidate</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<link rel="start" href="index.html" title="Tomoe Reference Manual">
<link rel="up" href="tomoe.html" title="Tomoe Core">
<link rel="prev" href="tomoe-tomoe.html" title="tomoe">
<link rel="next" href="TomoeChar.html" title="TomoeChar">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="tomoe.html" title="Tomoe Core">
<link rel="index" href="ix01.html" title="Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="tomoe-tomoe.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="tomoe.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Tomoe Reference Manual</th>
<td><a accesskey="n" href="TomoeChar.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2503282" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2547932" class="shortcut">Description</a>
                  &#160;|&#160;
                  <a href="#id2547854" class="shortcut">Object Hierarchy</a>
                  &#160;|&#160;
                  <a href="#id2547879" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="TomoeCandidate"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2503282"></a><span class="refentrytitle">TomoeCandidate</span>
</h2>
<p>TomoeCandidate &#8212; An object of search results.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



                    <a href="TomoeCandidate.html#TomoeCandidate-struct">TomoeCandidate</a>;
<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a>*     <a href="TomoeCandidate.html#tomoe-candidate-new">tomoe_candidate_new</a>                 (<a href="TomoeChar.html" title="TomoeChar">TomoeChar</a> *chr);
<a href="TomoeChar.html" title="TomoeChar">TomoeChar</a>*          <a href="TomoeCandidate.html#tomoe-candidate-get-char">tomoe_candidate_get_char</a>            (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand);
void                <a href="TomoeCandidate.html#tomoe-candidate-set-score">tomoe_candidate_set_score</a>           (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand,
                                                         gint score);
gint                <a href="TomoeCandidate.html#tomoe-candidate-get-score">tomoe_candidate_get_score</a>           (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand);
gint                <a href="TomoeCandidate.html#tomoe-candidate-compare">tomoe_candidate_compare</a>             (const <a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *a,
                                                         const <a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *b);

</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2547854"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">

  GObject
   +----TomoeCandidate
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2547879"></a><h2>Properties</h2>
<pre class="synopsis">

  "<a href="TomoeCandidate.html#TomoeCandidate--char">char</a>"                     <a href="TomoeChar.html" title="TomoeChar">TomoeChar</a>             : Read / Write / Construct Only
  "<a href="TomoeCandidate.html#TomoeCandidate--score">score</a>"                    guint                 : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2547932"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2547946"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2547956"></a><h3>
<a name="TomoeCandidate-struct"></a>TomoeCandidate</h3>
<a class="indexterm" name="id2547969"></a><pre class="programlisting">typedef struct _TomoeCandidate TomoeCandidate;</pre>
<p>
The <a href="TomoeCandidate.html" title="TomoeCandidate"><span class="type">TomoeCandidate</span></a> struct contains only
private fields and should not be directly accessed.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2547994"></a><h3>
<a name="tomoe-candidate-new"></a>tomoe_candidate_new ()</h3>
<a class="indexterm" name="id2548007"></a><pre class="programlisting"><a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a>*     tomoe_candidate_new                 (<a href="TomoeChar.html" title="TomoeChar">TomoeChar</a> *chr);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>chr</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2548064"></a><h3>
<a name="tomoe-candidate-get-char"></a>tomoe_candidate_get_char ()</h3>
<a class="indexterm" name="id2548076"></a><pre class="programlisting"><a href="TomoeChar.html" title="TomoeChar">TomoeChar</a>*          tomoe_candidate_get_char            (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>cand</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2548136"></a><h3>
<a name="tomoe-candidate-set-score"></a>tomoe_candidate_set_score ()</h3>
<a class="indexterm" name="id2548149"></a><pre class="programlisting">void                tomoe_candidate_set_score           (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand,
                                                         gint score);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>cand</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>score</code></em>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2548216"></a><h3>
<a name="tomoe-candidate-get-score"></a>tomoe_candidate_get_score ()</h3>
<a class="indexterm" name="id2548230"></a><pre class="programlisting">gint                tomoe_candidate_get_score           (<a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *cand);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>cand</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>


</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2548286"></a><h3>
<a name="tomoe-candidate-compare"></a>tomoe_candidate_compare ()</h3>
<a class="indexterm" name="id2548299"></a><pre class="programlisting">gint                tomoe_candidate_compare             (const <a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *a,
                                                         const <a href="TomoeCandidate.html" title="TomoeCandidate">TomoeCandidate</a> *b);</pre>
<p>
Compare two TomoeCandidate.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>a</code></em>&#160;:</span></td>
<td> 1st TomoeCandidate object to compare.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>b</code></em>&#160;:</span></td>
<td> 2nd TomoeCandidate object to compare.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> -1 a &lt; b, 0 a= b, 1 a &gt; b
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2548384"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2548394"></a><h3>
<a name="TomoeCandidate--char"></a>The "<code class="literal">char</code>" property</h3>
<a class="indexterm" name="id2548410"></a><pre class="programlisting">  "char"                     <a href="TomoeChar.html" title="TomoeChar">TomoeChar</a>             : Read / Write / Construct Only</pre>
<p>A TomoeChar object.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2548434"></a><h3>
<a name="TomoeCandidate--score"></a>The "<code class="literal">score</code>" property</h3>
<a class="indexterm" name="id2548450"></a><pre class="programlisting">  "score"                    guint                 : Read / Write</pre>
<p>Score of this candidate. Lower value has higher priority.</p>
<p>Allowed values: &lt;= G_MAXINT</p>
<p>Default value: 0</p>
</div>
</div>
</div>
</body>
</html>