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