File: gucharmap-gucharmap-chapters-model.html

package info (click to toggle)
gucharmap 1%3A9.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 8,960 kB
  • ctags: 1,428
  • sloc: ansic: 8,325; sh: 4,104; perl: 788; makefile: 423; xml: 126
file content (290 lines) | stat: -rw-r--r-- 17,275 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GucharmapChaptersModel: gucharmap Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="gucharmap Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="GucharmapBlockChaptersModel.html" title="GucharmapBlockChaptersModel">
<link rel="next" href="gucharmap-gucharmap-chartable.html" title="GucharmapChartable">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gucharmap-gucharmap-chapters-model.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gucharmap-gucharmap-chapters-model.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#gucharmap-gucharmap-chapters-model.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GucharmapBlockChaptersModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gucharmap-gucharmap-chartable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gucharmap-gucharmap-chapters-model"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gucharmap-gucharmap-chapters-model.top_of_page"></a>GucharmapChaptersModel</span></h2>
<p>GucharmapChaptersModel</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="returnvalue">GucharmapCodepointList</span></a> *
</td>
<td class="function_name">
<a class="link" href="gucharmap-gucharmap-chapters-model.html#gucharmap-chapters-model-get-codepoint-list" title="gucharmap_chapters_model_get_codepoint_list ()">gucharmap_chapters_model_get_codepoint_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="gucharmap-gucharmap-chapters-model.html#gucharmap-chapters-model-get-title" title="gucharmap_chapters_model_get_title ()">gucharmap_chapters_model_get_title</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="returnvalue">GucharmapCodepointList</span></a> *
</td>
<td class="function_name">
<a class="link" href="gucharmap-gucharmap-chapters-model.html#gucharmap-chapters-model-get-book-codepoint-list" title="gucharmap_chapters_model_get_book_codepoint_list ()">gucharmap_chapters_model_get_book_codepoint_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gucharmap-gucharmap-chapters-model.html#gucharmap-chapters-model-character-to-iter" title="gucharmap_chapters_model_character_to_iter ()">gucharmap_chapters_model_character_to_iter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gucharmap-gucharmap-chapters-model.html#gucharmap-chapters-model-id-to-iter" title="gucharmap_chapters_model_id_to_iter ()">gucharmap_chapters_model_id_to_iter</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GucharmapChaptersModel"></a><div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModelPrivate" title="GucharmapChaptersModelPrivate">GucharmapChaptersModelPrivate</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel-struct" title="struct GucharmapChaptersModel">GucharmapChaptersModel</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3GtkListStore.html#GtkListStore-struct">GtkListStore</a>
        <span class="lineart">╰──</span> GucharmapChaptersModel
            <span class="lineart">├──</span> <a class="link" href="GucharmapBlockChaptersModel.html" title="GucharmapBlockChaptersModel">GucharmapBlockChaptersModel</a>
            <span class="lineart">╰──</span> <a class="link" href="GucharmapScriptChaptersModel.html" title="GucharmapScriptChaptersModel">GucharmapScriptChaptersModel</a>
</pre>
</div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GucharmapChaptersModel implements
 <a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeModel-struct">GtkTreeModel</a>,  <a href="/usr/share/gtk-doc/html/gtk3gtk3-GtkTreeView-drag-and-drop.html#GtkTreeDragSource-struct">GtkTreeDragSource</a>,  <a href="/usr/share/gtk-doc/html/gtk3gtk3-GtkTreeView-drag-and-drop.html#GtkTreeDragDest-struct">GtkTreeDragDest</a>,  <a href="/usr/share/gtk-doc/html/gtk3GtkTreeSortable.html#GtkTreeSortable-struct">GtkTreeSortable</a> and  <a href="/usr/share/gtk-doc/html/gtk3GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gucharmap-chapters-model-get-codepoint-list"></a><h3>gucharmap_chapters_model_get_codepoint_list ()</h3>
<pre class="programlisting"><a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="returnvalue">GucharmapCodepointList</span></a> *
gucharmap_chapters_model_get_codepoint_list
                               (<em class="parameter"><code><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a> *chapters</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<p>Creates a new <a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="type">GucharmapCodepointList</span></a> representing the characters in the
current chapter.</p>
<div class="refsect3">
<a name="gucharmap-chapters-model-get-codepoint-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chapters</p></td>
<td class="parameter_description"><p>a <a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gucharmap-chapters-model-get-codepoint-list.returns"></a><h4>Returns</h4>
<p> the newly-created <a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="type">GucharmapCodepointList</span></a>,
or NULL if there is no chapter selected. The caller should release the
result with <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gucharmap-chapters-model-get-title"></a><h3>gucharmap_chapters_model_get_title ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
gucharmap_chapters_model_get_title (<em class="parameter"><code><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a> *chapters</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gucharmap-chapters-model-get-book-codepoint-list"></a><h3>gucharmap_chapters_model_get_book_codepoint_list ()</h3>
<pre class="programlisting"><a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="returnvalue">GucharmapCodepointList</span></a> *
gucharmap_chapters_model_get_book_codepoint_list
                               (<em class="parameter"><code><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a> *chapters</code></em>);</pre>
<div class="refsect3">
<a name="gucharmap-chapters-model-get-book-codepoint-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>chapters</p></td>
<td class="parameter_description"><p>a <a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gucharmap-chapters-model-get-book-codepoint-list.returns"></a><h4>Returns</h4>
<p> a reference to a <a class="link" href="GucharmapCodepointList.html" title="GucharmapCodepointList"><span class="type">GucharmapCodepointList</span></a>
representing all the characters in all the chapters. It should not be
modified, but must be <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>'d after use. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gucharmap-chapters-model-character-to-iter"></a><h3>gucharmap_chapters_model_character_to_iter ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gucharmap_chapters_model_character_to_iter
                               (<em class="parameter"><code><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a> *chapters</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glibglib-Unicode-Manipulation.html#gunichar"><span class="type">gunichar</span></a> wc</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
<div class="refsect3">
<a name="gucharmap-chapters-model-character-to-iter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chapters</p></td>
<td class="parameter_description"><p>a <a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>wc</p></td>
<td class="parameter_description"><p>a character</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gucharmap-chapters-model-character-to-iter.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gucharmap-chapters-model-id-to-iter"></a><h3>gucharmap_chapters_model_id_to_iter ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gucharmap_chapters_model_id_to_iter (<em class="parameter"><code><a class="link" href="gucharmap-gucharmap-chapters-model.html#GucharmapChaptersModel"><span class="type">GucharmapChaptersModel</span></a> *chapters_model</code></em>,
                                     <em class="parameter"><code>const <span class="type">char</span> *id</code></em>,
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3GtkTreeModel.html#GtkTreeIter-struct"><span class="type">GtkTreeIter</span></a> *_iter</code></em>);</pre>
<div class="refsect3">
<a name="gucharmap-chapters-model-id-to-iter.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gucharmap-chapters-model-id-to-iter.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gucharmap-gucharmap-chapters-model.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GucharmapChaptersModelPrivate"></a><h3>GucharmapChaptersModelPrivate</h3>
<pre class="programlisting">typedef struct _GucharmapChaptersModelPrivate GucharmapChaptersModelPrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GucharmapChaptersModel-struct"></a><h3>struct GucharmapChaptersModel</h3>
<pre class="programlisting">struct GucharmapChaptersModel;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>