]> git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-db.html
Imported Upstream version 3.4.0
[glabels] / docs / libglabels / html / libglabels-3.0-db.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Database: LibGlabels 3.0 Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
9 <link rel="prev" href="ch01.html" title="Basic LibGlabels Usage">
10 <link rel="next" href="libglabels-3.0-template.html" title="The lglTemplate Structure">
11 <meta name="generator" content="GTK-Doc V1.24 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18                   <a href="#libglabels-3.0-db.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libglabels-3.0-template.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libglabels-3.0-db"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libglabels-3.0-db.top_of_page"></a>Database</span></h2>
30 <p>Database — Database of pre-defined templates</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libglabels-3.0-db.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <span class="returnvalue">void</span>
45 </td>
46 <td class="function_name">
47 <a class="link" href="libglabels-3.0-db.html#lgl-db-init" title="lgl_db_init ()">lgl_db_init</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">void</span>
53 </td>
54 <td class="function_name">
55 <span class="c_punctuation">(</span><a class="link" href="libglabels-3.0-db.html#lglDbNotifyFunc" title="lglDbNotifyFunc ()">*lglDbNotifyFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a>
61 </td>
62 <td class="function_name">
63 <a class="link" href="libglabels-3.0-db.html#lgl-db-notify-add" title="lgl_db_notify_add ()">lgl_db_notify_add</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">void</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libglabels-3.0-db.html#lgl-db-notify-remove" title="lgl_db_notify_remove ()">lgl_db_notify_remove</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
77 </td>
78 <td class="function_name">
79 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-id-list" title="lgl_db_get_paper_id_list ()">lgl_db_get_paper_id_list</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">void</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-paper-id-list" title="lgl_db_free_paper_id_list ()">lgl_db_free_paper_id_list</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
93 </td>
94 <td class="function_name">
95 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-name-list" title="lgl_db_get_paper_name_list ()">lgl_db_get_paper_name_list</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">void</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-paper-name-list" title="lgl_db_free_paper_name_list ()">lgl_db_free_paper_name_list</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
109 </td>
110 <td class="function_name">
111 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-paper-from-id" title="lgl_db_lookup_paper_from_id ()">lgl_db_lookup_paper_from_id</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
117 </td>
118 <td class="function_name">
119 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-paper-from-name" title="lgl_db_lookup_paper_from_name ()">lgl_db_lookup_paper_from_name</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
125 </td>
126 <td class="function_name">
127 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-paper-id-from-name" title="lgl_db_lookup_paper_id_from_name ()">lgl_db_lookup_paper_id_from_name</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
133 </td>
134 <td class="function_name">
135 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-paper-name-from-id" title="lgl_db_lookup_paper_name_from_id ()">lgl_db_lookup_paper_name_from_id</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
141 </td>
142 <td class="function_name">
143 <a class="link" href="libglabels-3.0-db.html#lgl-db-is-paper-id-known" title="lgl_db_is_paper_id_known ()">lgl_db_is_paper_id_known</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
149 </td>
150 <td class="function_name">
151 <a class="link" href="libglabels-3.0-db.html#lgl-db-is-paper-id-other" title="lgl_db_is_paper_id_other ()">lgl_db_is_paper_id_other</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 <tr>
155 <td class="function_type">
156 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
157 </td>
158 <td class="function_name">
159 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-id-list" title="lgl_db_get_category_id_list ()">lgl_db_get_category_id_list</a> <span class="c_punctuation">()</span>
160 </td>
161 </tr>
162 <tr>
163 <td class="function_type">
164 <span class="returnvalue">void</span>
165 </td>
166 <td class="function_name">
167 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-category-id-list" title="lgl_db_free_category_id_list ()">lgl_db_free_category_id_list</a> <span class="c_punctuation">()</span>
168 </td>
169 </tr>
170 <tr>
171 <td class="function_type">
172 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
173 </td>
174 <td class="function_name">
175 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-name-list" title="lgl_db_get_category_name_list ()">lgl_db_get_category_name_list</a> <span class="c_punctuation">()</span>
176 </td>
177 </tr>
178 <tr>
179 <td class="function_type">
180 <span class="returnvalue">void</span>
181 </td>
182 <td class="function_name">
183 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-category-name-list" title="lgl_db_free_category_name_list ()">lgl_db_free_category_name_list</a> <span class="c_punctuation">()</span>
184 </td>
185 </tr>
186 <tr>
187 <td class="function_type">
188 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
189 </td>
190 <td class="function_name">
191 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-category-from-id" title="lgl_db_lookup_category_from_id ()">lgl_db_lookup_category_from_id</a> <span class="c_punctuation">()</span>
192 </td>
193 </tr>
194 <tr>
195 <td class="function_type">
196 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
197 </td>
198 <td class="function_name">
199 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-category-from-name" title="lgl_db_lookup_category_from_name ()">lgl_db_lookup_category_from_name</a> <span class="c_punctuation">()</span>
200 </td>
201 </tr>
202 <tr>
203 <td class="function_type">
204 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
205 </td>
206 <td class="function_name">
207 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-category-id-from-name" title="lgl_db_lookup_category_id_from_name ()">lgl_db_lookup_category_id_from_name</a> <span class="c_punctuation">()</span>
208 </td>
209 </tr>
210 <tr>
211 <td class="function_type">
212 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
213 </td>
214 <td class="function_name">
215 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-category-name-from-id" title="lgl_db_lookup_category_name_from_id ()">lgl_db_lookup_category_name_from_id</a> <span class="c_punctuation">()</span>
216 </td>
217 </tr>
218 <tr>
219 <td class="function_type">
220 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
221 </td>
222 <td class="function_name">
223 <a class="link" href="libglabels-3.0-db.html#lgl-db-is-category-id-known" title="lgl_db_is_category_id_known ()">lgl_db_is_category_id_known</a> <span class="c_punctuation">()</span>
224 </td>
225 </tr>
226 <tr>
227 <td class="function_type">
228 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
229 </td>
230 <td class="function_name">
231 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-brand-list" title="lgl_db_get_brand_list ()">lgl_db_get_brand_list</a> <span class="c_punctuation">()</span>
232 </td>
233 </tr>
234 <tr>
235 <td class="function_type">
236 <span class="returnvalue">void</span>
237 </td>
238 <td class="function_name">
239 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-brand-list" title="lgl_db_free_brand_list ()">lgl_db_free_brand_list</a> <span class="c_punctuation">()</span>
240 </td>
241 </tr>
242 <tr>
243 <td class="function_type">
244 <a class="link" href="libglabels-3.0-db.html#lglDbRegStatus" title="enum lglDbRegStatus"><span class="returnvalue">lglDbRegStatus</span></a>
245 </td>
246 <td class="function_name">
247 <a class="link" href="libglabels-3.0-db.html#lgl-db-register-template" title="lgl_db_register_template ()">lgl_db_register_template</a> <span class="c_punctuation">()</span>
248 </td>
249 </tr>
250 <tr>
251 <td class="function_type">
252 <a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="returnvalue">lglDbDeleteStatus</span></a>
253 </td>
254 <td class="function_name">
255 <a class="link" href="libglabels-3.0-db.html#lgl-db-delete-template-by-brand-part" title="lgl_db_delete_template_by_brand_part ()">lgl_db_delete_template_by_brand_part</a> <span class="c_punctuation">()</span>
256 </td>
257 </tr>
258 <tr>
259 <td class="function_type">
260 <a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="returnvalue">lglDbDeleteStatus</span></a>
261 </td>
262 <td class="function_name">
263 <a class="link" href="libglabels-3.0-db.html#lgl-db-delete-template-by-name" title="lgl_db_delete_template_by_name ()">lgl_db_delete_template_by_name</a> <span class="c_punctuation">()</span>
264 </td>
265 </tr>
266 <tr>
267 <td class="function_type">
268 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
269 </td>
270 <td class="function_name">
271 <a class="link" href="libglabels-3.0-db.html#lgl-db-does-template-exist" title="lgl_db_does_template_exist ()">lgl_db_does_template_exist</a> <span class="c_punctuation">()</span>
272 </td>
273 </tr>
274 <tr>
275 <td class="function_type">
276 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
277 </td>
278 <td class="function_name">
279 <a class="link" href="libglabels-3.0-db.html#lgl-db-does-template-name-exist" title="lgl_db_does_template_name_exist ()">lgl_db_does_template_name_exist</a> <span class="c_punctuation">()</span>
280 </td>
281 </tr>
282 <tr>
283 <td class="function_type">
284 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
285 </td>
286 <td class="function_name">
287 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-template-name-list-all" title="lgl_db_get_template_name_list_all ()">lgl_db_get_template_name_list_all</a> <span class="c_punctuation">()</span>
288 </td>
289 </tr>
290 <tr>
291 <td class="function_type">
292 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
293 </td>
294 <td class="function_name">
295 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-similar-template-name-list" title="lgl_db_get_similar_template_name_list ()">lgl_db_get_similar_template_name_list</a> <span class="c_punctuation">()</span>
296 </td>
297 </tr>
298 <tr>
299 <td class="function_type">
300 <span class="returnvalue">void</span>
301 </td>
302 <td class="function_name">
303 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-template-name-list" title="lgl_db_free_template_name_list ()">lgl_db_free_template_name_list</a> <span class="c_punctuation">()</span>
304 </td>
305 </tr>
306 <tr>
307 <td class="function_type">
308 <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *
309 </td>
310 <td class="function_name">
311 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-template-from-name" title="lgl_db_lookup_template_from_name ()">lgl_db_lookup_template_from_name</a> <span class="c_punctuation">()</span>
312 </td>
313 </tr>
314 <tr>
315 <td class="function_type">
316 <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *
317 </td>
318 <td class="function_name">
319 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-template-from-brand-part" title="lgl_db_lookup_template_from_brand_part ()">lgl_db_lookup_template_from_brand_part</a> <span class="c_punctuation">()</span>
320 </td>
321 </tr>
322 <tr>
323 <td class="function_type">
324 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
325 </td>
326 <td class="function_name">
327 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-vendor-name-list" title="lgl_db_get_vendor_name_list ()">lgl_db_get_vendor_name_list</a> <span class="c_punctuation">()</span>
328 </td>
329 </tr>
330 <tr>
331 <td class="function_type">
332 <span class="returnvalue">void</span>
333 </td>
334 <td class="function_name">
335 <a class="link" href="libglabels-3.0-db.html#lgl-db-free-vendor-name-list" title="lgl_db_free_vendor_name_list ()">lgl_db_free_vendor_name_list</a> <span class="c_punctuation">()</span>
336 </td>
337 </tr>
338 <tr>
339 <td class="function_type">
340 <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
341 </td>
342 <td class="function_name">
343 <a class="link" href="libglabels-3.0-db.html#lgl-db-is-vendor-name-known" title="lgl_db_is_vendor_name_known ()">lgl_db_is_vendor_name_known</a> <span class="c_punctuation">()</span>
344 </td>
345 </tr>
346 <tr>
347 <td class="function_type">
348 <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *
349 </td>
350 <td class="function_name">
351 <a class="link" href="libglabels-3.0-db.html#lgl-db-lookup-vendor-from-name" title="lgl_db_lookup_vendor_from_name ()">lgl_db_lookup_vendor_from_name</a> <span class="c_punctuation">()</span>
352 </td>
353 </tr>
354 <tr>
355 <td class="function_type">
356 <span class="returnvalue">void</span>
357 </td>
358 <td class="function_name">
359 <a class="link" href="libglabels-3.0-db.html#lgl-db-print-known-papers" title="lgl_db_print_known_papers ()">lgl_db_print_known_papers</a> <span class="c_punctuation">()</span>
360 </td>
361 </tr>
362 <tr>
363 <td class="function_type">
364 <span class="returnvalue">void</span>
365 </td>
366 <td class="function_name">
367 <a class="link" href="libglabels-3.0-db.html#lgl-db-print-known-categories" title="lgl_db_print_known_categories ()">lgl_db_print_known_categories</a> <span class="c_punctuation">()</span>
368 </td>
369 </tr>
370 <tr>
371 <td class="function_type">
372 <span class="returnvalue">void</span>
373 </td>
374 <td class="function_name">
375 <a class="link" href="libglabels-3.0-db.html#lgl-db-print-known-templates" title="lgl_db_print_known_templates ()">lgl_db_print_known_templates</a> <span class="c_punctuation">()</span>
376 </td>
377 </tr>
378 <tr>
379 <td class="function_type">
380 <span class="returnvalue">void</span>
381 </td>
382 <td class="function_name">
383 <a class="link" href="libglabels-3.0-db.html#lgl-db-print-known-vendors" title="lgl_db_print_known_vendors ()">lgl_db_print_known_vendors</a> <span class="c_punctuation">()</span>
384 </td>
385 </tr>
386 </tbody>
387 </table></div>
388 </div>
389 <div class="refsect1">
390 <a name="libglabels-3.0-db.other"></a><h2>Types and Values</h2>
391 <div class="informaltable"><table width="100%" border="0">
392 <colgroup>
393 <col width="150px" class="name">
394 <col class="description">
395 </colgroup>
396 <tbody>
397 <tr>
398 <td class="datatype_keyword">enum</td>
399 <td class="function_name"><a class="link" href="libglabels-3.0-db.html#lglDbRegStatus" title="enum lglDbRegStatus">lglDbRegStatus</a></td>
400 </tr>
401 <tr>
402 <td class="datatype_keyword">enum</td>
403 <td class="function_name"><a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus">lglDbDeleteStatus</a></td>
404 </tr>
405 </tbody>
406 </table></div>
407 </div>
408 <div class="refsect1">
409 <a name="libglabels-3.0-db.includes"></a><h2>Includes</h2>
410 <pre class="synopsis">#include &lt;libglabels/lgl-db.h&gt;
411 </pre>
412 </div>
413 <div class="refsect1">
414 <a name="libglabels-3.0-db.description"></a><h2>Description</h2>
415 <p>
416 This section describes a set of functions to locate and add templates and related information in
417 the LibGlabels template database.
418 </p>
419 </div>
420 <div class="refsect1">
421 <a name="libglabels-3.0-db.functions_details"></a><h2>Functions</h2>
422 <div class="refsect2">
423 <a name="lgl-db-init"></a><h3>lgl_db_init ()</h3>
424 <pre class="programlisting"><span class="returnvalue">void</span>
425 lgl_db_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
426 <p>Initialize all libglabels subsystems.  It is not necessary for an application to call
427 <a class="link" href="libglabels-3.0-db.html#lgl-db-init" title="lgl_db_init ()"><code class="function">lgl_db_init()</code></a>, because libglabels will initialize on demand.  An application programmer may
428 choose to call <a class="link" href="libglabels-3.0-db.html#lgl-db-init" title="lgl_db_init ()"><code class="function">lgl_db_init()</code></a> at startup to minimize the impact of the first libglabels call
429 on GUI response time.</p>
430 <p>This function initializes its paper definitions, category definitions, vendor definitions,
431 and its template database. It will search both system and user template directories to locate
432 this data.</p>
433 </div>
434 <hr>
435 <div class="refsect2">
436 <a name="lglDbNotifyFunc"></a><h3>lglDbNotifyFunc ()</h3>
437 <pre class="programlisting"><span class="returnvalue">void</span>
438 <span class="c_punctuation">(</span>*lglDbNotifyFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
439 <p>
440 Defines the type of notify callback function to be called when database changes.
441 </p>
442 <div class="refsect3">
443 <a name="id-1.2.2.7.3.5"></a><h4>Parameters</h4>
444 <div class="informaltable"><table width="100%" border="0">
445 <colgroup>
446 <col width="150px" class="parameters_name">
447 <col class="parameters_description">
448 <col width="200px" class="parameters_annotations">
449 </colgroup>
450 <tbody><tr>
451 <td class="parameter_name"><p>user_data</p></td>
452 <td class="parameter_description"><p>Pointer to user data that is passed to the notify function.</p></td>
453 <td class="parameter_annotations"> </td>
454 </tr></tbody>
455 </table></div>
456 </div>
457 </div>
458 <hr>
459 <div class="refsect2">
460 <a name="lgl-db-notify-add"></a><h3>lgl_db_notify_add ()</h3>
461 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="returnvalue">gulong</span></a>
462 lgl_db_notify_add (<em class="parameter"><code><a class="link" href="libglabels-3.0-db.html#lglDbNotifyFunc" title="lglDbNotifyFunc ()"><span class="type">lglDbNotifyFunc</span></a> func</code></em>,
463                    <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
464 <p>Register a notification callback function to be called when the database changes.</p>
465 <div class="refsect3">
466 <a name="id-1.2.2.7.4.5"></a><h4>Parameters</h4>
467 <div class="informaltable"><table width="100%" border="0">
468 <colgroup>
469 <col width="150px" class="parameters_name">
470 <col class="parameters_description">
471 <col width="200px" class="parameters_annotations">
472 </colgroup>
473 <tbody>
474 <tr>
475 <td class="parameter_name"><p>func</p></td>
476 <td class="parameter_description"><p>Callback function to be called when database changes.</p></td>
477 <td class="parameter_annotations"> </td>
478 </tr>
479 <tr>
480 <td class="parameter_name"><p>user_data</p></td>
481 <td class="parameter_description"><p>Passback user data to supply to callback function.</p></td>
482 <td class="parameter_annotations"> </td>
483 </tr>
484 </tbody>
485 </table></div>
486 </div>
487 <div class="refsect3">
488 <a name="id-1.2.2.7.4.6"></a><h4>Returns</h4>
489 <p> an ID for this notification registration.</p>
490 </div>
491 </div>
492 <hr>
493 <div class="refsect2">
494 <a name="lgl-db-notify-remove"></a><h3>lgl_db_notify_remove ()</h3>
495 <pre class="programlisting"><span class="returnvalue">void</span>
496 lgl_db_notify_remove (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> id</code></em>);</pre>
497 <p>Cancel a previous registration a notification callback function.</p>
498 <div class="refsect3">
499 <a name="id-1.2.2.7.5.5"></a><h4>Parameters</h4>
500 <div class="informaltable"><table width="100%" border="0">
501 <colgroup>
502 <col width="150px" class="parameters_name">
503 <col class="parameters_description">
504 <col width="200px" class="parameters_annotations">
505 </colgroup>
506 <tbody><tr>
507 <td class="parameter_name"><p>id</p></td>
508 <td class="parameter_description"><p>ID of notification registration to cancel (see <a class="link" href="libglabels-3.0-db.html#lgl-db-notify-add" title="lgl_db_notify_add ()"><code class="function">lgl_db_notify_add()</code></a>).</p></td>
509 <td class="parameter_annotations"> </td>
510 </tr></tbody>
511 </table></div>
512 </div>
513 </div>
514 <hr>
515 <div class="refsect2">
516 <a name="lgl-db-get-paper-id-list"></a><h3>lgl_db_get_paper_id_list ()</h3>
517 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
518 lgl_db_get_paper_id_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
519 <p>Get a list of all paper ids known to libglabels.</p>
520 <div class="refsect3">
521 <a name="id-1.2.2.7.6.5"></a><h4>Returns</h4>
522 <p> a list of paper ids.</p>
523 </div>
524 </div>
525 <hr>
526 <div class="refsect2">
527 <a name="lgl-db-free-paper-id-list"></a><h3>lgl_db_free_paper_id_list ()</h3>
528 <pre class="programlisting"><span class="returnvalue">void</span>
529 lgl_db_free_paper_id_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *ids</code></em>);</pre>
530 <p>Free up all storage associated with an id list obtained with
531 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-id-list" title="lgl_db_get_paper_id_list ()"><code class="function">lgl_db_get_paper_id_list()</code></a>.</p>
532 <div class="refsect3">
533 <a name="id-1.2.2.7.7.5"></a><h4>Parameters</h4>
534 <div class="informaltable"><table width="100%" border="0">
535 <colgroup>
536 <col width="150px" class="parameters_name">
537 <col class="parameters_description">
538 <col width="200px" class="parameters_annotations">
539 </colgroup>
540 <tbody><tr>
541 <td class="parameter_name"><p>ids</p></td>
542 <td class="parameter_description"><p>List of id strings to be freed.</p></td>
543 <td class="parameter_annotations"> </td>
544 </tr></tbody>
545 </table></div>
546 </div>
547 </div>
548 <hr>
549 <div class="refsect2">
550 <a name="lgl-db-get-paper-name-list"></a><h3>lgl_db_get_paper_name_list ()</h3>
551 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
552 lgl_db_get_paper_name_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
553 <p>Get a list of all localized paper names known to libglabels.</p>
554 <div class="refsect3">
555 <a name="id-1.2.2.7.8.5"></a><h4>Returns</h4>
556 <p> a list of localized paper names.</p>
557 </div>
558 </div>
559 <hr>
560 <div class="refsect2">
561 <a name="lgl-db-free-paper-name-list"></a><h3>lgl_db_free_paper_name_list ()</h3>
562 <pre class="programlisting"><span class="returnvalue">void</span>
563 lgl_db_free_paper_name_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *names</code></em>);</pre>
564 <p>Free up all storage associated with a name list obtained with
565 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-name-list" title="lgl_db_get_paper_name_list ()"><code class="function">lgl_db_get_paper_name_list()</code></a>.</p>
566 <div class="refsect3">
567 <a name="id-1.2.2.7.9.5"></a><h4>Parameters</h4>
568 <div class="informaltable"><table width="100%" border="0">
569 <colgroup>
570 <col width="150px" class="parameters_name">
571 <col class="parameters_description">
572 <col width="200px" class="parameters_annotations">
573 </colgroup>
574 <tbody><tr>
575 <td class="parameter_name"><p>names</p></td>
576 <td class="parameter_description"><p>List of localized paper name strings to be freed.</p></td>
577 <td class="parameter_annotations"> </td>
578 </tr></tbody>
579 </table></div>
580 </div>
581 </div>
582 <hr>
583 <div class="refsect2">
584 <a name="lgl-db-lookup-paper-from-id"></a><h3>lgl_db_lookup_paper_from_id ()</h3>
585 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
586 lgl_db_lookup_paper_from_id (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
587 <p>Lookup paper definition from id string.</p>
588 <div class="refsect3">
589 <a name="id-1.2.2.7.10.5"></a><h4>Parameters</h4>
590 <div class="informaltable"><table width="100%" border="0">
591 <colgroup>
592 <col width="150px" class="parameters_name">
593 <col class="parameters_description">
594 <col width="200px" class="parameters_annotations">
595 </colgroup>
596 <tbody><tr>
597 <td class="parameter_name"><p>id</p></td>
598 <td class="parameter_description"><p>paper id string</p></td>
599 <td class="parameter_annotations"> </td>
600 </tr></tbody>
601 </table></div>
602 </div>
603 <div class="refsect3">
604 <a name="id-1.2.2.7.10.6"></a><h4>Returns</h4>
605 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</p>
606 </div>
607 </div>
608 <hr>
609 <div class="refsect2">
610 <a name="lgl-db-lookup-paper-from-name"></a><h3>lgl_db_lookup_paper_from_name ()</h3>
611 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
612 lgl_db_lookup_paper_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
613 <p>Lookup paper definition from localized paper name string.</p>
614 <div class="refsect3">
615 <a name="id-1.2.2.7.11.5"></a><h4>Parameters</h4>
616 <div class="informaltable"><table width="100%" border="0">
617 <colgroup>
618 <col width="150px" class="parameters_name">
619 <col class="parameters_description">
620 <col width="200px" class="parameters_annotations">
621 </colgroup>
622 <tbody><tr>
623 <td class="parameter_name"><p>name</p></td>
624 <td class="parameter_description"><p>localized paper name string</p></td>
625 <td class="parameter_annotations"> </td>
626 </tr></tbody>
627 </table></div>
628 </div>
629 <div class="refsect3">
630 <a name="id-1.2.2.7.11.6"></a><h4>Returns</h4>
631 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</p>
632 </div>
633 </div>
634 <hr>
635 <div class="refsect2">
636 <a name="lgl-db-lookup-paper-id-from-name"></a><h3>lgl_db_lookup_paper_id_from_name ()</h3>
637 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
638 lgl_db_lookup_paper_id_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
639 <p>Lookup paper name string from localized paper name string.</p>
640 <div class="refsect3">
641 <a name="id-1.2.2.7.12.5"></a><h4>Parameters</h4>
642 <div class="informaltable"><table width="100%" border="0">
643 <colgroup>
644 <col width="150px" class="parameters_name">
645 <col class="parameters_description">
646 <col width="200px" class="parameters_annotations">
647 </colgroup>
648 <tbody><tr>
649 <td class="parameter_name"><p>name</p></td>
650 <td class="parameter_description"><p>localized paper name stringp</p></td>
651 <td class="parameter_annotations"> </td>
652 </tr></tbody>
653 </table></div>
654 </div>
655 <div class="refsect3">
656 <a name="id-1.2.2.7.12.6"></a><h4>Returns</h4>
657 <p> pointer to a newly allocated id string.</p>
658 </div>
659 </div>
660 <hr>
661 <div class="refsect2">
662 <a name="lgl-db-lookup-paper-name-from-id"></a><h3>lgl_db_lookup_paper_name_from_id ()</h3>
663 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
664 lgl_db_lookup_paper_name_from_id (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
665 <p>Lookup localized paper name string from paper id string.</p>
666 <div class="refsect3">
667 <a name="id-1.2.2.7.13.5"></a><h4>Parameters</h4>
668 <div class="informaltable"><table width="100%" border="0">
669 <colgroup>
670 <col width="150px" class="parameters_name">
671 <col class="parameters_description">
672 <col width="200px" class="parameters_annotations">
673 </colgroup>
674 <tbody><tr>
675 <td class="parameter_name"><p>id</p></td>
676 <td class="parameter_description"><p>paper id string</p></td>
677 <td class="parameter_annotations"> </td>
678 </tr></tbody>
679 </table></div>
680 </div>
681 <div class="refsect3">
682 <a name="id-1.2.2.7.13.6"></a><h4>Returns</h4>
683 <p> pointer to a newly allocated localized paper name string.</p>
684 </div>
685 </div>
686 <hr>
687 <div class="refsect2">
688 <a name="lgl-db-is-paper-id-known"></a><h3>lgl_db_is_paper_id_known ()</h3>
689 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
690 lgl_db_is_paper_id_known (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
691 <p>Determine if given paper id is known to libglabels.</p>
692 <div class="refsect3">
693 <a name="id-1.2.2.7.14.5"></a><h4>Parameters</h4>
694 <div class="informaltable"><table width="100%" border="0">
695 <colgroup>
696 <col width="150px" class="parameters_name">
697 <col class="parameters_description">
698 <col width="200px" class="parameters_annotations">
699 </colgroup>
700 <tbody><tr>
701 <td class="parameter_name"><p>id</p></td>
702 <td class="parameter_description"><p>paper id to test</p></td>
703 <td class="parameter_annotations"> </td>
704 </tr></tbody>
705 </table></div>
706 </div>
707 <div class="refsect3">
708 <a name="id-1.2.2.7.14.6"></a><h4>Returns</h4>
709 <p> TRUE if id is known, otherwise FALSE.</p>
710 </div>
711 </div>
712 <hr>
713 <div class="refsect2">
714 <a name="lgl-db-is-paper-id-other"></a><h3>lgl_db_is_paper_id_other ()</h3>
715 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
716 lgl_db_is_paper_id_other (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
717 <p>Determine if given paper id is the special id "Other."</p>
718 <div class="refsect3">
719 <a name="id-1.2.2.7.15.5"></a><h4>Parameters</h4>
720 <div class="informaltable"><table width="100%" border="0">
721 <colgroup>
722 <col width="150px" class="parameters_name">
723 <col class="parameters_description">
724 <col width="200px" class="parameters_annotations">
725 </colgroup>
726 <tbody><tr>
727 <td class="parameter_name"><p>id</p></td>
728 <td class="parameter_description"><p>paper id to test</p></td>
729 <td class="parameter_annotations"> </td>
730 </tr></tbody>
731 </table></div>
732 </div>
733 <div class="refsect3">
734 <a name="id-1.2.2.7.15.6"></a><h4>Returns</h4>
735 <p> TRUE if id is "Other", otherwise FALSE.</p>
736 </div>
737 </div>
738 <hr>
739 <div class="refsect2">
740 <a name="lgl-db-get-category-id-list"></a><h3>lgl_db_get_category_id_list ()</h3>
741 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
742 lgl_db_get_category_id_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
743 <p>Get a list of all category ids known to libglabels.</p>
744 <div class="refsect3">
745 <a name="id-1.2.2.7.16.5"></a><h4>Returns</h4>
746 <p> a list of category ids.</p>
747 </div>
748 </div>
749 <hr>
750 <div class="refsect2">
751 <a name="lgl-db-free-category-id-list"></a><h3>lgl_db_free_category_id_list ()</h3>
752 <pre class="programlisting"><span class="returnvalue">void</span>
753 lgl_db_free_category_id_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *ids</code></em>);</pre>
754 <p>Free up all storage associated with an id list obtained with
755 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-id-list" title="lgl_db_get_category_id_list ()"><code class="function">lgl_db_get_category_id_list()</code></a>.</p>
756 <div class="refsect3">
757 <a name="id-1.2.2.7.17.5"></a><h4>Parameters</h4>
758 <div class="informaltable"><table width="100%" border="0">
759 <colgroup>
760 <col width="150px" class="parameters_name">
761 <col class="parameters_description">
762 <col width="200px" class="parameters_annotations">
763 </colgroup>
764 <tbody><tr>
765 <td class="parameter_name"><p>ids</p></td>
766 <td class="parameter_description"><p>List of id strings to be freed.</p></td>
767 <td class="parameter_annotations"> </td>
768 </tr></tbody>
769 </table></div>
770 </div>
771 </div>
772 <hr>
773 <div class="refsect2">
774 <a name="lgl-db-get-category-name-list"></a><h3>lgl_db_get_category_name_list ()</h3>
775 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
776 lgl_db_get_category_name_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
777 <p>Get a list of all localized category names known to libglabels.</p>
778 <div class="refsect3">
779 <a name="id-1.2.2.7.18.5"></a><h4>Returns</h4>
780 <p> a list of localized category names.</p>
781 </div>
782 </div>
783 <hr>
784 <div class="refsect2">
785 <a name="lgl-db-free-category-name-list"></a><h3>lgl_db_free_category_name_list ()</h3>
786 <pre class="programlisting"><span class="returnvalue">void</span>
787 lgl_db_free_category_name_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *names</code></em>);</pre>
788 <p>Free up all storage associated with a name list obtained with
789 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-name-list" title="lgl_db_get_category_name_list ()"><code class="function">lgl_db_get_category_name_list()</code></a>.</p>
790 <div class="refsect3">
791 <a name="id-1.2.2.7.19.5"></a><h4>Parameters</h4>
792 <div class="informaltable"><table width="100%" border="0">
793 <colgroup>
794 <col width="150px" class="parameters_name">
795 <col class="parameters_description">
796 <col width="200px" class="parameters_annotations">
797 </colgroup>
798 <tbody><tr>
799 <td class="parameter_name"><p>names</p></td>
800 <td class="parameter_description"><p>List of localized category name strings to be freed.</p></td>
801 <td class="parameter_annotations"> </td>
802 </tr></tbody>
803 </table></div>
804 </div>
805 </div>
806 <hr>
807 <div class="refsect2">
808 <a name="lgl-db-lookup-category-from-id"></a><h3>lgl_db_lookup_category_from_id ()</h3>
809 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
810 lgl_db_lookup_category_from_id (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
811 <p>Lookup category definition from id string.</p>
812 <div class="refsect3">
813 <a name="id-1.2.2.7.20.5"></a><h4>Parameters</h4>
814 <div class="informaltable"><table width="100%" border="0">
815 <colgroup>
816 <col width="150px" class="parameters_name">
817 <col class="parameters_description">
818 <col width="200px" class="parameters_annotations">
819 </colgroup>
820 <tbody><tr>
821 <td class="parameter_name"><p>id</p></td>
822 <td class="parameter_description"><p>category id string</p></td>
823 <td class="parameter_annotations"> </td>
824 </tr></tbody>
825 </table></div>
826 </div>
827 <div class="refsect3">
828 <a name="id-1.2.2.7.20.6"></a><h4>Returns</h4>
829 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
830 </div>
831 </div>
832 <hr>
833 <div class="refsect2">
834 <a name="lgl-db-lookup-category-from-name"></a><h3>lgl_db_lookup_category_from_name ()</h3>
835 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
836 lgl_db_lookup_category_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
837 <p>Lookup category definition from localized category name string.</p>
838 <div class="refsect3">
839 <a name="id-1.2.2.7.21.5"></a><h4>Parameters</h4>
840 <div class="informaltable"><table width="100%" border="0">
841 <colgroup>
842 <col width="150px" class="parameters_name">
843 <col class="parameters_description">
844 <col width="200px" class="parameters_annotations">
845 </colgroup>
846 <tbody><tr>
847 <td class="parameter_name"><p>name</p></td>
848 <td class="parameter_description"><p>localized category name string</p></td>
849 <td class="parameter_annotations"> </td>
850 </tr></tbody>
851 </table></div>
852 </div>
853 <div class="refsect3">
854 <a name="id-1.2.2.7.21.6"></a><h4>Returns</h4>
855 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
856 </div>
857 </div>
858 <hr>
859 <div class="refsect2">
860 <a name="lgl-db-lookup-category-id-from-name"></a><h3>lgl_db_lookup_category_id_from_name ()</h3>
861 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
862 lgl_db_lookup_category_id_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
863 <p>Lookup category name string from localized category name string.</p>
864 <div class="refsect3">
865 <a name="id-1.2.2.7.22.5"></a><h4>Parameters</h4>
866 <div class="informaltable"><table width="100%" border="0">
867 <colgroup>
868 <col width="150px" class="parameters_name">
869 <col class="parameters_description">
870 <col width="200px" class="parameters_annotations">
871 </colgroup>
872 <tbody><tr>
873 <td class="parameter_name"><p>name</p></td>
874 <td class="parameter_description"><p>localized category name stringp</p></td>
875 <td class="parameter_annotations"> </td>
876 </tr></tbody>
877 </table></div>
878 </div>
879 <div class="refsect3">
880 <a name="id-1.2.2.7.22.6"></a><h4>Returns</h4>
881 <p> pointer to a newly allocated id string.</p>
882 </div>
883 </div>
884 <hr>
885 <div class="refsect2">
886 <a name="lgl-db-lookup-category-name-from-id"></a><h3>lgl_db_lookup_category_name_from_id ()</h3>
887 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
888 lgl_db_lookup_category_name_from_id (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
889 <p>Lookup localized category name string from category id string.</p>
890 <div class="refsect3">
891 <a name="id-1.2.2.7.23.5"></a><h4>Parameters</h4>
892 <div class="informaltable"><table width="100%" border="0">
893 <colgroup>
894 <col width="150px" class="parameters_name">
895 <col class="parameters_description">
896 <col width="200px" class="parameters_annotations">
897 </colgroup>
898 <tbody><tr>
899 <td class="parameter_name"><p>id</p></td>
900 <td class="parameter_description"><p>category id string</p></td>
901 <td class="parameter_annotations"> </td>
902 </tr></tbody>
903 </table></div>
904 </div>
905 <div class="refsect3">
906 <a name="id-1.2.2.7.23.6"></a><h4>Returns</h4>
907 <p> pointer to a newly allocated localized category name string.</p>
908 </div>
909 </div>
910 <hr>
911 <div class="refsect2">
912 <a name="lgl-db-is-category-id-known"></a><h3>lgl_db_is_category_id_known ()</h3>
913 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
914 lgl_db_is_category_id_known (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
915 <p>Determine if given category id is known to libglabels.</p>
916 <div class="refsect3">
917 <a name="id-1.2.2.7.24.5"></a><h4>Parameters</h4>
918 <div class="informaltable"><table width="100%" border="0">
919 <colgroup>
920 <col width="150px" class="parameters_name">
921 <col class="parameters_description">
922 <col width="200px" class="parameters_annotations">
923 </colgroup>
924 <tbody><tr>
925 <td class="parameter_name"><p>id</p></td>
926 <td class="parameter_description"><p>category id to test</p></td>
927 <td class="parameter_annotations"> </td>
928 </tr></tbody>
929 </table></div>
930 </div>
931 <div class="refsect3">
932 <a name="id-1.2.2.7.24.6"></a><h4>Returns</h4>
933 <p> TRUE if id is known, otherwise FALSE.</p>
934 </div>
935 </div>
936 <hr>
937 <div class="refsect2">
938 <a name="lgl-db-get-brand-list"></a><h3>lgl_db_get_brand_list ()</h3>
939 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
940 lgl_db_get_brand_list (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *paper_id</code></em>,
941                        <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category_id</code></em>);</pre>
942 <p>Get a list of all valid brands of templates in the template database.
943 Results can be filtered by page size and/or template category.  A list of valid page
944 sizes can be obtained using <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-id-list" title="lgl_db_get_paper_id_list ()"><code class="function">lgl_db_get_paper_id_list()</code></a>.  A list of valid template
945 categories can be obtained using <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-id-list" title="lgl_db_get_category_id_list ()"><code class="function">lgl_db_get_category_id_list()</code></a>.</p>
946 <div class="refsect3">
947 <a name="id-1.2.2.7.25.5"></a><h4>Parameters</h4>
948 <div class="informaltable"><table width="100%" border="0">
949 <colgroup>
950 <col width="150px" class="parameters_name">
951 <col class="parameters_description">
952 <col width="200px" class="parameters_annotations">
953 </colgroup>
954 <tbody>
955 <tr>
956 <td class="parameter_name"><p>paper_id</p></td>
957 <td class="parameter_description"><p>If non NULL, limit results to given page size.</p></td>
958 <td class="parameter_annotations"> </td>
959 </tr>
960 <tr>
961 <td class="parameter_name"><p>category_id</p></td>
962 <td class="parameter_description"><p>If non NULL, limit results to given template category.</p></td>
963 <td class="parameter_annotations"> </td>
964 </tr>
965 </tbody>
966 </table></div>
967 </div>
968 <div class="refsect3">
969 <a name="id-1.2.2.7.25.6"></a><h4>Returns</h4>
970 <p> a list of brands</p>
971 </div>
972 </div>
973 <hr>
974 <div class="refsect2">
975 <a name="lgl-db-free-brand-list"></a><h3>lgl_db_free_brand_list ()</h3>
976 <pre class="programlisting"><span class="returnvalue">void</span>
977 lgl_db_free_brand_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *brands</code></em>);</pre>
978 <p>Free up all storage associated with a list of template names obtained with
979 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-brand-list" title="lgl_db_get_brand_list ()"><code class="function">lgl_db_get_brand_list()</code></a>.</p>
980 <div class="refsect3">
981 <a name="id-1.2.2.7.26.5"></a><h4>Parameters</h4>
982 <div class="informaltable"><table width="100%" border="0">
983 <colgroup>
984 <col width="150px" class="parameters_name">
985 <col class="parameters_description">
986 <col width="200px" class="parameters_annotations">
987 </colgroup>
988 <tbody><tr>
989 <td class="parameter_name"><p>brands</p></td>
990 <td class="parameter_description"><p>List of template brand strings to be freed.</p></td>
991 <td class="parameter_annotations"> </td>
992 </tr></tbody>
993 </table></div>
994 </div>
995 </div>
996 <hr>
997 <div class="refsect2">
998 <a name="lgl-db-register-template"></a><h3>lgl_db_register_template ()</h3>
999 <pre class="programlisting"><a class="link" href="libglabels-3.0-db.html#lglDbRegStatus" title="enum lglDbRegStatus"><span class="returnvalue">lglDbRegStatus</span></a>
1000 lgl_db_register_template (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> *template</code></em>);</pre>
1001 <p>Register a template.  This function adds a template to the template database.
1002 The template will be stored in an individual XML file in the user template directory.</p>
1003 <div class="refsect3">
1004 <a name="id-1.2.2.7.27.5"></a><h4>Parameters</h4>
1005 <div class="informaltable"><table width="100%" border="0">
1006 <colgroup>
1007 <col width="150px" class="parameters_name">
1008 <col class="parameters_description">
1009 <col width="200px" class="parameters_annotations">
1010 </colgroup>
1011 <tbody><tr>
1012 <td class="parameter_name"><p>template</p></td>
1013 <td class="parameter_description"><p>Pointer to a template structure to add to database.</p></td>
1014 <td class="parameter_annotations"> </td>
1015 </tr></tbody>
1016 </table></div>
1017 </div>
1018 <div class="refsect3">
1019 <a name="id-1.2.2.7.27.6"></a><h4>Returns</h4>
1020 <p> Status of registration attempt (<a class="link" href="libglabels-3.0-db.html#lglDbRegStatus" title="enum lglDbRegStatus"><span class="type">lglDbRegStatus</span></a>)</p>
1021 </div>
1022 </div>
1023 <hr>
1024 <div class="refsect2">
1025 <a name="lgl-db-delete-template-by-brand-part"></a><h3>lgl_db_delete_template_by_brand_part ()</h3>
1026 <pre class="programlisting"><a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="returnvalue">lglDbDeleteStatus</span></a>
1027 lgl_db_delete_template_by_brand_part (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *brand</code></em>,
1028                                       <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *part</code></em>);</pre>
1029 <p>Delete a user defined template.  This function deletes a template from
1030 the template database. The individual XML file in the user template
1031 directory will also be removed.</p>
1032 <div class="refsect3">
1033 <a name="id-1.2.2.7.28.5"></a><h4>Parameters</h4>
1034 <div class="informaltable"><table width="100%" border="0">
1035 <colgroup>
1036 <col width="150px" class="parameters_name">
1037 <col class="parameters_description">
1038 <col width="200px" class="parameters_annotations">
1039 </colgroup>
1040 <tbody>
1041 <tr>
1042 <td class="parameter_name"><p>brand</p></td>
1043 <td class="parameter_description"><p>Brand name or vendor of template to be deleted.</p></td>
1044 <td class="parameter_annotations"> </td>
1045 </tr>
1046 <tr>
1047 <td class="parameter_name"><p>part</p></td>
1048 <td class="parameter_description"><p>Part name or number of template to be deleted.</p></td>
1049 <td class="parameter_annotations"> </td>
1050 </tr>
1051 </tbody>
1052 </table></div>
1053 </div>
1054 <div class="refsect3">
1055 <a name="id-1.2.2.7.28.6"></a><h4>Returns</h4>
1056 <p> Status of registration attempt (<a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="type">lglDbDeleteStatus</span></a>)</p>
1057 </div>
1058 </div>
1059 <hr>
1060 <div class="refsect2">
1061 <a name="lgl-db-delete-template-by-name"></a><h3>lgl_db_delete_template_by_name ()</h3>
1062 <pre class="programlisting"><a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="returnvalue">lglDbDeleteStatus</span></a>
1063 lgl_db_delete_template_by_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1064 <p>Delete a user defined template.  This function deletes a template from
1065 the template database. The individual XML file in the user template
1066 directory will also be removed.</p>
1067 <div class="refsect3">
1068 <a name="id-1.2.2.7.29.5"></a><h4>Parameters</h4>
1069 <div class="informaltable"><table width="100%" border="0">
1070 <colgroup>
1071 <col width="150px" class="parameters_name">
1072 <col class="parameters_description">
1073 <col width="200px" class="parameters_annotations">
1074 </colgroup>
1075 <tbody><tr>
1076 <td class="parameter_name"><p>name</p></td>
1077 <td class="parameter_description"><p>Name of template to be deleted.</p></td>
1078 <td class="parameter_annotations"> </td>
1079 </tr></tbody>
1080 </table></div>
1081 </div>
1082 <div class="refsect3">
1083 <a name="id-1.2.2.7.29.6"></a><h4>Returns</h4>
1084 <p> Status of registration attempt (<a class="link" href="libglabels-3.0-db.html#lglDbDeleteStatus" title="enum lglDbDeleteStatus"><span class="type">lglDbDeleteStatus</span></a>)</p>
1085 </div>
1086 </div>
1087 <hr>
1088 <div class="refsect2">
1089 <a name="lgl-db-does-template-exist"></a><h3>lgl_db_does_template_exist ()</h3>
1090 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1091 lgl_db_does_template_exist (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *brand</code></em>,
1092                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *part</code></em>);</pre>
1093 <p>This function tests whether a template with the given brand and part name/number exists.</p>
1094 <div class="refsect3">
1095 <a name="id-1.2.2.7.30.5"></a><h4>Parameters</h4>
1096 <div class="informaltable"><table width="100%" border="0">
1097 <colgroup>
1098 <col width="150px" class="parameters_name">
1099 <col class="parameters_description">
1100 <col width="200px" class="parameters_annotations">
1101 </colgroup>
1102 <tbody>
1103 <tr>
1104 <td class="parameter_name"><p>brand</p></td>
1105 <td class="parameter_description"><p>Brand name.</p></td>
1106 <td class="parameter_annotations"> </td>
1107 </tr>
1108 <tr>
1109 <td class="parameter_name"><p>part</p></td>
1110 <td class="parameter_description"><p>Part name/number.</p></td>
1111 <td class="parameter_annotations"> </td>
1112 </tr>
1113 </tbody>
1114 </table></div>
1115 </div>
1116 <div class="refsect3">
1117 <a name="id-1.2.2.7.30.6"></a><h4>Returns</h4>
1118 <p>  TRUE if such a template exists in the database.</p>
1119 </div>
1120 </div>
1121 <hr>
1122 <div class="refsect2">
1123 <a name="lgl-db-does-template-name-exist"></a><h3>lgl_db_does_template_name_exist ()</h3>
1124 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1125 lgl_db_does_template_name_exist (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1126 <p>This function test whether a template with the given name exists.</p>
1127 <div class="refsect3">
1128 <a name="id-1.2.2.7.31.5"></a><h4>Parameters</h4>
1129 <div class="informaltable"><table width="100%" border="0">
1130 <colgroup>
1131 <col width="150px" class="parameters_name">
1132 <col class="parameters_description">
1133 <col width="200px" class="parameters_annotations">
1134 </colgroup>
1135 <tbody><tr>
1136 <td class="parameter_name"><p>name</p></td>
1137 <td class="parameter_description"><p>name string</p></td>
1138 <td class="parameter_annotations"> </td>
1139 </tr></tbody>
1140 </table></div>
1141 </div>
1142 <div class="refsect3">
1143 <a name="id-1.2.2.7.31.6"></a><h4>Returns</h4>
1144 <p> TRUE if such a template exists in the database.</p>
1145 </div>
1146 </div>
1147 <hr>
1148 <div class="refsect2">
1149 <a name="lgl-db-get-template-name-list-all"></a><h3>lgl_db_get_template_name_list_all ()</h3>
1150 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
1151 lgl_db_get_template_name_list_all (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *brand</code></em>,
1152                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *paper_id</code></em>,
1153                                    <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *category_id</code></em>);</pre>
1154 <p>Get a list of all valid names of templates in the template database.
1155 Results can be filtered by page size and/or template category.  A list of valid page
1156 sizes can be obtained using <a class="link" href="libglabels-3.0-db.html#lgl-db-get-paper-id-list" title="lgl_db_get_paper_id_list ()"><code class="function">lgl_db_get_paper_id_list()</code></a>.  A list of valid template
1157 categories can be obtained using <a class="link" href="libglabels-3.0-db.html#lgl-db-get-category-id-list" title="lgl_db_get_category_id_list ()"><code class="function">lgl_db_get_category_id_list()</code></a>.</p>
1158 <div class="refsect3">
1159 <a name="id-1.2.2.7.32.5"></a><h4>Parameters</h4>
1160 <div class="informaltable"><table width="100%" border="0">
1161 <colgroup>
1162 <col width="150px" class="parameters_name">
1163 <col class="parameters_description">
1164 <col width="200px" class="parameters_annotations">
1165 </colgroup>
1166 <tbody>
1167 <tr>
1168 <td class="parameter_name"><p>brand</p></td>
1169 <td class="parameter_description"><p>If non NULL, limit results to given brand</p></td>
1170 <td class="parameter_annotations"> </td>
1171 </tr>
1172 <tr>
1173 <td class="parameter_name"><p>paper_id</p></td>
1174 <td class="parameter_description"><p>If non NULL, limit results to given page size.</p></td>
1175 <td class="parameter_annotations"> </td>
1176 </tr>
1177 <tr>
1178 <td class="parameter_name"><p>category_id</p></td>
1179 <td class="parameter_description"><p>If non NULL, limit results to given template category.</p></td>
1180 <td class="parameter_annotations"> </td>
1181 </tr>
1182 </tbody>
1183 </table></div>
1184 </div>
1185 <div class="refsect3">
1186 <a name="id-1.2.2.7.32.6"></a><h4>Returns</h4>
1187 <p> a list of template names.</p>
1188 </div>
1189 </div>
1190 <hr>
1191 <div class="refsect2">
1192 <a name="lgl-db-get-similar-template-name-list"></a><h3>lgl_db_get_similar_template_name_list ()</h3>
1193 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
1194 lgl_db_get_similar_template_name_list (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1195 <p>Get a list of all valid names of templates in the template database that
1196 have the same size and layout characteristics as the given template.</p>
1197 <div class="refsect3">
1198 <a name="id-1.2.2.7.33.5"></a><h4>Parameters</h4>
1199 <div class="informaltable"><table width="100%" border="0">
1200 <colgroup>
1201 <col width="150px" class="parameters_name">
1202 <col class="parameters_description">
1203 <col width="200px" class="parameters_annotations">
1204 </colgroup>
1205 <tbody><tr>
1206 <td class="parameter_name"><p>name</p></td>
1207 <td class="parameter_description"><p>Name of template under test.</p></td>
1208 <td class="parameter_annotations"> </td>
1209 </tr></tbody>
1210 </table></div>
1211 </div>
1212 <div class="refsect3">
1213 <a name="id-1.2.2.7.33.6"></a><h4>Returns</h4>
1214 <p> a list of template names.</p>
1215 </div>
1216 </div>
1217 <hr>
1218 <div class="refsect2">
1219 <a name="lgl-db-free-template-name-list"></a><h3>lgl_db_free_template_name_list ()</h3>
1220 <pre class="programlisting"><span class="returnvalue">void</span>
1221 lgl_db_free_template_name_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *names</code></em>);</pre>
1222 <p>Free up all storage associated with a list of template names obtained with
1223 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-template-name-list-all" title="lgl_db_get_template_name_list_all ()"><code class="function">lgl_db_get_template_name_list_all()</code></a>.</p>
1224 <div class="refsect3">
1225 <a name="id-1.2.2.7.34.5"></a><h4>Parameters</h4>
1226 <div class="informaltable"><table width="100%" border="0">
1227 <colgroup>
1228 <col width="150px" class="parameters_name">
1229 <col class="parameters_description">
1230 <col width="200px" class="parameters_annotations">
1231 </colgroup>
1232 <tbody><tr>
1233 <td class="parameter_name"><p>names</p></td>
1234 <td class="parameter_description"><p>List of template name strings to be freed.</p></td>
1235 <td class="parameter_annotations"> </td>
1236 </tr></tbody>
1237 </table></div>
1238 </div>
1239 </div>
1240 <hr>
1241 <div class="refsect2">
1242 <a name="lgl-db-lookup-template-from-name"></a><h3>lgl_db_lookup_template_from_name ()</h3>
1243 <pre class="programlisting"><a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *
1244 lgl_db_lookup_template_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1245 <p>Lookup template in template database from name string.</p>
1246 <div class="refsect3">
1247 <a name="id-1.2.2.7.35.5"></a><h4>Parameters</h4>
1248 <div class="informaltable"><table width="100%" border="0">
1249 <colgroup>
1250 <col width="150px" class="parameters_name">
1251 <col class="parameters_description">
1252 <col width="200px" class="parameters_annotations">
1253 </colgroup>
1254 <tbody><tr>
1255 <td class="parameter_name"><p>name</p></td>
1256 <td class="parameter_description"><p>name string</p></td>
1257 <td class="parameter_annotations"> </td>
1258 </tr></tbody>
1259 </table></div>
1260 </div>
1261 <div class="refsect3">
1262 <a name="id-1.2.2.7.35.6"></a><h4>Returns</h4>
1263 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> structure.</p>
1264 </div>
1265 </div>
1266 <hr>
1267 <div class="refsect2">
1268 <a name="lgl-db-lookup-template-from-brand-part"></a><h3>lgl_db_lookup_template_from_brand_part ()</h3>
1269 <pre class="programlisting"><a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *
1270 lgl_db_lookup_template_from_brand_part
1271                                (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *brand</code></em>,
1272                                 <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *part</code></em>);</pre>
1273 <p>Lookup template in template database from brand and part strings.</p>
1274 <div class="refsect3">
1275 <a name="id-1.2.2.7.36.5"></a><h4>Parameters</h4>
1276 <div class="informaltable"><table width="100%" border="0">
1277 <colgroup>
1278 <col width="150px" class="parameters_name">
1279 <col class="parameters_description">
1280 <col width="200px" class="parameters_annotations">
1281 </colgroup>
1282 <tbody>
1283 <tr>
1284 <td class="parameter_name"><p>brand</p></td>
1285 <td class="parameter_description"><p>brand name string</p></td>
1286 <td class="parameter_annotations"> </td>
1287 </tr>
1288 <tr>
1289 <td class="parameter_name"><p>part</p></td>
1290 <td class="parameter_description"><p>part name string</p></td>
1291 <td class="parameter_annotations"> </td>
1292 </tr>
1293 </tbody>
1294 </table></div>
1295 </div>
1296 <div class="refsect3">
1297 <a name="id-1.2.2.7.36.6"></a><h4>Returns</h4>
1298 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> structure.</p>
1299 </div>
1300 </div>
1301 <hr>
1302 <div class="refsect2">
1303 <a name="lgl-db-get-vendor-name-list"></a><h3>lgl_db_get_vendor_name_list ()</h3>
1304 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
1305 lgl_db_get_vendor_name_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1306 <p>Get a list of all localized vendor names known to libglabels.</p>
1307 <div class="refsect3">
1308 <a name="id-1.2.2.7.37.5"></a><h4>Returns</h4>
1309 <p> a list of localized vendor names.</p>
1310 </div>
1311 </div>
1312 <hr>
1313 <div class="refsect2">
1314 <a name="lgl-db-free-vendor-name-list"></a><h3>lgl_db_free_vendor_name_list ()</h3>
1315 <pre class="programlisting"><span class="returnvalue">void</span>
1316 lgl_db_free_vendor_name_list (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *names</code></em>);</pre>
1317 <p>Free up all storage associated with a name list obtained with
1318 <a class="link" href="libglabels-3.0-db.html#lgl-db-get-vendor-name-list" title="lgl_db_get_vendor_name_list ()"><code class="function">lgl_db_get_vendor_name_list()</code></a>.</p>
1319 <div class="refsect3">
1320 <a name="id-1.2.2.7.38.5"></a><h4>Parameters</h4>
1321 <div class="informaltable"><table width="100%" border="0">
1322 <colgroup>
1323 <col width="150px" class="parameters_name">
1324 <col class="parameters_description">
1325 <col width="200px" class="parameters_annotations">
1326 </colgroup>
1327 <tbody><tr>
1328 <td class="parameter_name"><p>names</p></td>
1329 <td class="parameter_description"><p>List of localized vendor name strings to be freed.</p></td>
1330 <td class="parameter_annotations"> </td>
1331 </tr></tbody>
1332 </table></div>
1333 </div>
1334 </div>
1335 <hr>
1336 <div class="refsect2">
1337 <a name="lgl-db-is-vendor-name-known"></a><h3>lgl_db_is_vendor_name_known ()</h3>
1338 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1339 lgl_db_is_vendor_name_known (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1340 <p>Determine if given vendor id is known to libglabels.</p>
1341 <div class="refsect3">
1342 <a name="id-1.2.2.7.39.5"></a><h4>Parameters</h4>
1343 <div class="informaltable"><table width="100%" border="0">
1344 <colgroup>
1345 <col width="150px" class="parameters_name">
1346 <col class="parameters_description">
1347 <col width="200px" class="parameters_annotations">
1348 </colgroup>
1349 <tbody><tr>
1350 <td class="parameter_name"><p>name</p></td>
1351 <td class="parameter_description"><p>vendor name to test</p></td>
1352 <td class="parameter_annotations"> </td>
1353 </tr></tbody>
1354 </table></div>
1355 </div>
1356 <div class="refsect3">
1357 <a name="id-1.2.2.7.39.6"></a><h4>Returns</h4>
1358 <p> TRUE if id is known, otherwise FALSE.</p>
1359 </div>
1360 </div>
1361 <hr>
1362 <div class="refsect2">
1363 <a name="lgl-db-lookup-vendor-from-name"></a><h3>lgl_db_lookup_vendor_from_name ()</h3>
1364 <pre class="programlisting"><a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="returnvalue">lglVendor</span></a> *
1365 lgl_db_lookup_vendor_from_name (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
1366 <p>Lookup vendor definition from localized vendor name string.</p>
1367 <div class="refsect3">
1368 <a name="id-1.2.2.7.40.5"></a><h4>Parameters</h4>
1369 <div class="informaltable"><table width="100%" border="0">
1370 <colgroup>
1371 <col width="150px" class="parameters_name">
1372 <col class="parameters_description">
1373 <col width="200px" class="parameters_annotations">
1374 </colgroup>
1375 <tbody><tr>
1376 <td class="parameter_name"><p>name</p></td>
1377 <td class="parameter_description"><p>localized vendor name string</p></td>
1378 <td class="parameter_annotations"> </td>
1379 </tr></tbody>
1380 </table></div>
1381 </div>
1382 <div class="refsect3">
1383 <a name="id-1.2.2.7.40.6"></a><h4>Returns</h4>
1384 <p> pointer to a newly allocated <a class="link" href="libglabels-3.0-vendor.html#lglVendor" title="struct lglVendor"><span class="type">lglVendor</span></a> structure.</p>
1385 </div>
1386 </div>
1387 <hr>
1388 <div class="refsect2">
1389 <a name="lgl-db-print-known-papers"></a><h3>lgl_db_print_known_papers ()</h3>
1390 <pre class="programlisting"><span class="returnvalue">void</span>
1391 lgl_db_print_known_papers (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1392 <p>For debugging purposes: print a list of all paper definitions known to
1393 libglabels.</p>
1394 </div>
1395 <hr>
1396 <div class="refsect2">
1397 <a name="lgl-db-print-known-categories"></a><h3>lgl_db_print_known_categories ()</h3>
1398 <pre class="programlisting"><span class="returnvalue">void</span>
1399 lgl_db_print_known_categories (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1400 <p>For debugging purposes: print a list of all category definitions known to
1401 libglabels.</p>
1402 </div>
1403 <hr>
1404 <div class="refsect2">
1405 <a name="lgl-db-print-known-templates"></a><h3>lgl_db_print_known_templates ()</h3>
1406 <pre class="programlisting"><span class="returnvalue">void</span>
1407 lgl_db_print_known_templates (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1408 <p>Print all known templates (for debugging purposes).</p>
1409 </div>
1410 <hr>
1411 <div class="refsect2">
1412 <a name="lgl-db-print-known-vendors"></a><h3>lgl_db_print_known_vendors ()</h3>
1413 <pre class="programlisting"><span class="returnvalue">void</span>
1414 lgl_db_print_known_vendors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1415 <p>For debugging purposes: print a list of all vendor definitions known to
1416 libglabels.</p>
1417 </div>
1418 </div>
1419 <div class="refsect1">
1420 <a name="libglabels-3.0-db.other_details"></a><h2>Types and Values</h2>
1421 <div class="refsect2">
1422 <a name="lglDbRegStatus"></a><h3>enum lglDbRegStatus</h3>
1423 <p>
1424 This enumeration defines a set of possible return values for <a class="link" href="libglabels-3.0-db.html#lgl-db-register-template" title="lgl_db_register_template ()"><code class="function">lgl_db_register_template()</code></a>.
1425 </p>
1426 <div class="refsect3">
1427 <a name="id-1.2.2.8.2.4"></a><h4>Members</h4>
1428 <div class="informaltable"><table width="100%" border="0">
1429 <colgroup>
1430 <col width="300px" class="enum_members_name">
1431 <col class="enum_members_description">
1432 <col width="200px" class="enum_members_annotations">
1433 </colgroup>
1434 <tbody>
1435 <tr>
1436 <td class="enum_member_name"><p><a name="LGL-DB-REG-OK:CAPS"></a>LGL_DB_REG_OK</p></td>
1437 <td class="enum_member_description">
1438 <p>Registration successful.</p>
1439 </td>
1440 <td class="enum_member_annotations"> </td>
1441 </tr>
1442 <tr>
1443 <td class="enum_member_name"><p><a name="LGL-DB-REG-BAD-PAPER-ID:CAPS"></a>LGL_DB_REG_BAD_PAPER_ID</p></td>
1444 <td class="enum_member_description">
1445 <p> Registration failed because paper id is unknown.</p>
1446 </td>
1447 <td class="enum_member_annotations"> </td>
1448 </tr>
1449 <tr>
1450 <td class="enum_member_name"><p><a name="LGL-DB-REG-BRAND-PART-EXISTS:CAPS"></a>LGL_DB_REG_BRAND_PART_EXISTS</p></td>
1451 <td class="enum_member_description">
1452 <p>Registration failed because template with same brand and part name/number already exists.</p>
1453 </td>
1454 <td class="enum_member_annotations"> </td>
1455 </tr>
1456 <tr>
1457 <td class="enum_member_name"><p><a name="LGL-DB-REG-FILE-WRITE-ERROR:CAPS"></a>LGL_DB_REG_FILE_WRITE_ERROR</p></td>
1458 <td class="enum_member_description">
1459 <p>Registration failed because an error while writing to disk.</p>
1460 </td>
1461 <td class="enum_member_annotations"> </td>
1462 </tr>
1463 </tbody>
1464 </table></div>
1465 </div>
1466 </div>
1467 <hr>
1468 <div class="refsect2">
1469 <a name="lglDbDeleteStatus"></a><h3>enum lglDbDeleteStatus</h3>
1470 <p>
1471 This enumeration defines a set of possible return values for <a class="link" href="libglabels-3.0-db.html#lgl-db-delete-template-by-name" title="lgl_db_delete_template_by_name ()"><code class="function">lgl_db_delete_template_by_name()</code></a> or <a class="link" href="libglabels-3.0-db.html#lgl-db-delete-template-by-brand-part" title="lgl_db_delete_template_by_brand_part ()"><code class="function">lgl_db_delete_template_by_brand_part()</code></a>.
1472 </p>
1473 <div class="refsect3">
1474 <a name="id-1.2.2.8.3.4"></a><h4>Members</h4>
1475 <div class="informaltable"><table width="100%" border="0">
1476 <colgroup>
1477 <col width="300px" class="enum_members_name">
1478 <col class="enum_members_description">
1479 <col width="200px" class="enum_members_annotations">
1480 </colgroup>
1481 <tbody>
1482 <tr>
1483 <td class="enum_member_name"><p><a name="LGL-DB-DELETE-OK:CAPS"></a>LGL_DB_DELETE_OK</p></td>
1484 <td class="enum_member_description">
1485 <p>Deletion successful.</p>
1486 </td>
1487 <td class="enum_member_annotations"> </td>
1488 </tr>
1489 <tr>
1490 <td class="enum_member_name"><p><a name="LGL-DB-DELETE-DOES-NOT-EXIST:CAPS"></a>LGL_DB_DELETE_DOES_NOT_EXIST</p></td>
1491 <td class="enum_member_description">
1492 <p>Deletion failed because template with given brand and part name/number does not exist.</p>
1493 </td>
1494 <td class="enum_member_annotations"> </td>
1495 </tr>
1496 <tr>
1497 <td class="enum_member_name"><p><a name="LGL-DB-DELETE-NOT-USER-DEFINED:CAPS"></a>LGL_DB_DELETE_NOT_USER_DEFINED</p></td>
1498 <td class="enum_member_description">
1499 <p>Deletion failed because given template is not a user defined template.</p>
1500 </td>
1501 <td class="enum_member_annotations"> </td>
1502 </tr>
1503 <tr>
1504 <td class="enum_member_name"><p><a name="LGL-DB-DELETE-FILE-ERROR:CAPS"></a>LGL_DB_DELETE_FILE_ERROR</p></td>
1505 <td class="enum_member_description">
1506 <p>Deletion failed because of an error while attempting to remove template from disk.</p>
1507 </td>
1508 <td class="enum_member_annotations"> </td>
1509 </tr>
1510 </tbody>
1511 </table></div>
1512 </div>
1513 </div>
1514 </div>
1515 </div>
1516 <div class="footer">
1517 <hr>Generated by GTK-Doc V1.24</div>
1518 </body>
1519 </html>