git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="LibGlabels 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-template.html" title="The lglTemplate Structure">
  11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 <link rel="chapter" href="ch01.html" title="Basic LibGlabels Usage">
  14 <link rel="chapter" href="ch02.html" title="Working Directly With LibGlabels XML">
  15 <link rel="chapter" href="ch03.html" title="Miscellaneous">
  16 </head>
  17 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  18 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  19 <tr valign="middle">
  20 <td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  23 <th width="100%" align="center">LibGlabels Reference Manual</th>
  24 <td><a accesskey="n" href="libglabels-template.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  25 </tr>
  26 <tr><td colspan="5" class="shortcuts">
  27 <a href="#libglabels-db.synopsis" class="shortcut">Top</a>
  28                  |
  29                 <a href="#libglabels-db.description" class="shortcut">Description</a>
  30 </td></tr>
  31 </table>
  32 <div class="refentry" title="Database">
  33 <a name="libglabels-db"></a><div class="titlepage"></div>
  34 <div class="refnamediv"><table width="100%"><tr>
  35 <td valign="top">
  36 <h2><span class="refentrytitle"><a name="libglabels-db.top_of_page"></a>Database</span></h2>
  37 <p>Database — Database of pre-defined templates</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv" title="Synopsis">
  42 <a name="libglabels-db.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">
  44
  45 #include &lt;libglabels/db.h&gt;
  46
  47 enum                <a class="link" href="libglabels-db.html#lglDbRegStatus" title="enum lglDbRegStatus">lglDbRegStatus</a>;
  48
  49 void                <a class="link" href="libglabels-db.html#lgl-db-init" title="lgl_db_init ()">lgl_db_init</a>                         (void);
  50
  51 <a
  52 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  53 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-paper-id-list" title="lgl_db_get_paper_id_list ()">lgl_db_get_paper_id_list</a>            (void);
  54 void                <a class="link" href="libglabels-db.html#lgl-db-free-paper-id-list" title="lgl_db_free_paper_id_list ()">lgl_db_free_paper_id_list</a>           (<a
  55 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  56 >GList</a> *ids);
  57 <a
  58 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  59 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-paper-name-list" title="lgl_db_get_paper_name_list ()">lgl_db_get_paper_name_list</a>          (void);
  60 void                <a class="link" href="libglabels-db.html#lgl-db-free-paper-name-list" title="lgl_db_free_paper_name_list ()">lgl_db_free_paper_name_list</a>         (<a
  61 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  62 >GList</a> *names);
  63 <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          <a class="link" href="libglabels-db.html#lgl-db-lookup-paper-from-id" title="lgl_db_lookup_paper_from_id ()">lgl_db_lookup_paper_from_id</a>         (const <a
  64 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  65 >gchar</a> *id);
  66 <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          <a class="link" href="libglabels-db.html#lgl-db-lookup-paper-from-name" title="lgl_db_lookup_paper_from_name ()">lgl_db_lookup_paper_from_name</a>       (const <a
  67 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  68 >gchar</a> *name);
  69 <a
  70 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  71 >gchar</a> *             <a class="link" href="libglabels-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>    (const <a
  72 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  73 >gchar</a> *name);
  74 <a
  75 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  76 >gchar</a> *             <a class="link" href="libglabels-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>    (const <a
  77 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  78 >gchar</a> *id);
  79 <a
  80 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
  81 >gboolean</a>            <a class="link" href="libglabels-db.html#lgl-db-is-paper-id-known" title="lgl_db_is_paper_id_known ()">lgl_db_is_paper_id_known</a>            (const <a
  82 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  83 >gchar</a> *id);
  84 <a
  85 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
  86 >gboolean</a>            <a class="link" href="libglabels-db.html#lgl-db-is-paper-id-other" title="lgl_db_is_paper_id_other ()">lgl_db_is_paper_id_other</a>            (const <a
  87 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  88 >gchar</a> *id);
  89
  90 <a
  91 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  92 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-category-id-list" title="lgl_db_get_category_id_list ()">lgl_db_get_category_id_list</a>         (void);
  93 void                <a class="link" href="libglabels-db.html#lgl-db-free-category-id-list" title="lgl_db_free_category_id_list ()">lgl_db_free_category_id_list</a>        (<a
  94 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  95 >GList</a> *ids);
  96 <a
  97 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  98 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-category-name-list" title="lgl_db_get_category_name_list ()">lgl_db_get_category_name_list</a>       (void);
  99 void                <a class="link" href="libglabels-db.html#lgl-db-free-category-name-list" title="lgl_db_free_category_name_list ()">lgl_db_free_category_name_list</a>      (<a
 100 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 101 >GList</a> *names);
 102 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       <a class="link" href="libglabels-db.html#lgl-db-lookup-category-from-id" title="lgl_db_lookup_category_from_id ()">lgl_db_lookup_category_from_id</a>      (const <a
 103 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 104 >gchar</a> *id);
 105 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       <a class="link" href="libglabels-db.html#lgl-db-lookup-category-from-name" title="lgl_db_lookup_category_from_name ()">lgl_db_lookup_category_from_name</a>    (const <a
 106 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 107 >gchar</a> *name);
 108 <a
 109 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 110 >gchar</a> *             <a class="link" href="libglabels-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> (const <a
 111 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 112 >gchar</a> *name);
 113 <a
 114 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 115 >gchar</a> *             <a class="link" href="libglabels-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> (const <a
 116 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 117 >gchar</a> *id);
 118 <a
 119 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 120 >gboolean</a>            <a class="link" href="libglabels-db.html#lgl-db-is-category-id-known" title="lgl_db_is_category_id_known ()">lgl_db_is_category_id_known</a>         (const <a
 121 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 122 >gchar</a> *id);
 123
 124 <a
 125 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 126 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-brand-list" title="lgl_db_get_brand_list ()">lgl_db_get_brand_list</a>               (const <a
 127 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 128 >gchar</a> *paper_id,
 129                                                          const <a
 130 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 131 >gchar</a> *category_id);
 132 void                <a class="link" href="libglabels-db.html#lgl-db-free-brand-list" title="lgl_db_free_brand_list ()">lgl_db_free_brand_list</a>              (<a
 133 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 134 >GList</a> *brands);
 135
 136 <a class="link" href="libglabels-db.html#lglDbRegStatus" title="enum lglDbRegStatus">lglDbRegStatus</a>      <a class="link" href="libglabels-db.html#lgl-db-register-template" title="lgl_db_register_template ()">lgl_db_register_template</a>            (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);
 137 <a
 138 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 139 >gboolean</a>            <a class="link" href="libglabels-db.html#lgl-db-does-template-exist" title="lgl_db_does_template_exist ()">lgl_db_does_template_exist</a>          (const <a
 140 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 141 >gchar</a> *brand,
 142                                                          const <a
 143 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 144 >gchar</a> *part);
 145 <a
 146 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 147 >gboolean</a>            <a class="link" href="libglabels-db.html#lgl-db-does-template-name-exist" title="lgl_db_does_template_name_exist ()">lgl_db_does_template_name_exist</a>     (const <a
 148 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 149 >gchar</a> *name);
 150 <a
 151 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 152 >GList</a> *             <a class="link" href="libglabels-db.html#lgl-db-get-template-name-list-unique" title="lgl_db_get_template_name_list_unique ()">lgl_db_get_template_name_list_unique</a>
 153                                                         (const <a
 154 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 155 >gchar</a> *brand,
 156                                                          const <a
 157 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 158 >gchar</a> *paper_id,
 159                                                          const <a
 160 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 161 >gchar</a> *category_id);
 162 <a
 163 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 164 >GList</a> *             <a class="link" href="libglabels-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>   (const <a
 165 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 166 >gchar</a> *brand,
 167                                                          const <a
 168 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 169 >gchar</a> *paper_id,
 170                                                          const <a
 171 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 172 >gchar</a> *category_id);
 173 void                <a class="link" href="libglabels-db.html#lgl-db-free-template-name-list" title="lgl_db_free_template_name_list ()">lgl_db_free_template_name_list</a>      (<a
 174 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 175 >GList</a> *names);
 176 <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       <a class="link" href="libglabels-db.html#lgl-db-lookup-template-from-name" title="lgl_db_lookup_template_from_name ()">lgl_db_lookup_template_from_name</a>    (const <a
 177 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 178 >gchar</a> *name);
 179
 180 void                <a class="link" href="libglabels-db.html#lgl-db-print-known-papers" title="lgl_db_print_known_papers ()">lgl_db_print_known_papers</a>           (void);
 181 void                <a class="link" href="libglabels-db.html#lgl-db-print-known-categories" title="lgl_db_print_known_categories ()">lgl_db_print_known_categories</a>       (void);
 182 void                <a class="link" href="libglabels-db.html#lgl-db-print-known-templates" title="lgl_db_print_known_templates ()">lgl_db_print_known_templates</a>        (void);
 183 void                <a class="link" href="libglabels-db.html#lgl-db-print-aliases" title="lgl_db_print_aliases ()">lgl_db_print_aliases</a>                (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);
 184 </pre>
 185 </div>
 186 <div class="refsect1" title="Description">
 187 <a name="libglabels-db.description"></a><h2>Description</h2>
 188 <p>
 189 This section describes a set of functions to locate and add templates and related information in
 190 the LibGlabels template database.
 191 </p>
 192 </div>
 193 <div class="refsect1" title="Details">
 194 <a name="libglabels-db.details"></a><h2>Details</h2>
 195 <div class="refsect2" title="enum lglDbRegStatus">
 196 <a name="lglDbRegStatus"></a><h3>enum lglDbRegStatus</h3>
 197 <pre class="programlisting">typedef enum
 198 {
 199         LGL_DB_REG_OK                =  0,
 200         LGL_DB_REG_BAD_PAPER_ID      = -1,
 201         LGL_DB_REG_BRAND_PART_EXISTS = -2,
 202         LGL_DB_REG_FILE_WRITE_ERROR  = -3
 203 } lglDbRegStatus;
 204 </pre>
 205 <p>
 206 This enumeration defines a set of possible return values for <a class="link" href="libglabels-db.html#lgl-db-register-template" title="lgl_db_register_template ()"><code class="function">lgl_db_register_template()</code></a>.
 207 </p>
 208 <div class="variablelist"><table border="0">
 209 <col align="left" valign="top">
 210 <tbody>
 211 <tr>
 212 <td><p><a name="LGL-DB-REG-OK--CAPS"></a><span class="term"><code class="literal">LGL_DB_REG_OK</code></span></p></td>
 213 <td>Registration successful.
 214 </td>
 215 </tr>
 216 <tr>
 217 <td><p><a name="LGL-DB-REG-BAD-PAPER-ID--CAPS"></a><span class="term"><code class="literal">LGL_DB_REG_BAD_PAPER_ID</code></span></p></td>
 218 <td> Registration failed because paper id is unknown.
 219 </td>
 220 </tr>
 221 <tr>
 222 <td><p><a name="LGL-DB-REG-BRAND-PART-EXISTS--CAPS"></a><span class="term"><code class="literal">LGL_DB_REG_BRAND_PART_EXISTS</code></span></p></td>
 223 <td>Registration failed because template with same brand and part name/number already exists.
 224 </td>
 225 </tr>
 226 <tr>
 227 <td><p><a name="LGL-DB-REG-FILE-WRITE-ERROR--CAPS"></a><span class="term"><code class="literal">LGL_DB_REG_FILE_WRITE_ERROR</code></span></p></td>
 228 <td>Registration failed because an error while writing to disk.
 229 </td>
 230 </tr>
 231 </tbody>
 232 </table></div>
 233 </div>
 234 <hr>
 235 <div class="refsect2" title="lgl_db_init ()">
 236 <a name="lgl-db-init"></a><h3>lgl_db_init ()</h3>
 237 <pre class="programlisting">void                lgl_db_init                         (void);</pre>
 238 <p>
 239 Initialize all libglabels subsystems.  It is not necessary for an application to call
 240 <a class="link" href="libglabels-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
 241 choose to call <a class="link" href="libglabels-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
 242 on GUI response time.
 243 </p>
 244 <p>
 245 This function initializes its paper definitions, category definitions, and its template
 246 database.. It will search both system and user template directories to locate
 247 this data.</p>
 248 <p>
 249 </p>
 250 </div>
 251 <hr>
 252 <div class="refsect2" title="lgl_db_get_paper_id_list ()">
 253 <a name="lgl-db-get-paper-id-list"></a><h3>lgl_db_get_paper_id_list ()</h3>
 254 <pre class="programlisting"><a
 255 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 256 >GList</a> *             lgl_db_get_paper_id_list            (void);</pre>
 257 <p>
 258 Get a list of all paper ids known to libglabels.</p>
 259 <p>
 260 </p>
 261 <div class="variablelist"><table border="0">
 262 <col align="left" valign="top">
 263 <tbody><tr>
 264 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 265 <td> a list of paper ids.
 266
 267 </td>
 268 </tr></tbody>
 269 </table></div>
 270 </div>
 271 <hr>
 272 <div class="refsect2" title="lgl_db_free_paper_id_list ()">
 273 <a name="lgl-db-free-paper-id-list"></a><h3>lgl_db_free_paper_id_list ()</h3>
 274 <pre class="programlisting">void                lgl_db_free_paper_id_list           (<a
 275 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 276 >GList</a> *ids);</pre>
 277 <p>
 278 Free up all storage associated with an id list obtained with
 279 <a class="link" href="libglabels-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>
 280 <p>
 281 </p>
 282 <div class="variablelist"><table border="0">
 283 <col align="left" valign="top">
 284 <tbody><tr>
 285 <td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
 286 <td> List of id strings to be freed.
 287 </td>
 288 </tr></tbody>
 289 </table></div>
 290 </div>
 291 <hr>
 292 <div class="refsect2" title="lgl_db_get_paper_name_list ()">
 293 <a name="lgl-db-get-paper-name-list"></a><h3>lgl_db_get_paper_name_list ()</h3>
 294 <pre class="programlisting"><a
 295 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 296 >GList</a> *             lgl_db_get_paper_name_list          (void);</pre>
 297 <p>
 298 Get a list of all localized paper names known to libglabels.</p>
 299 <p>
 300 </p>
 301 <div class="variablelist"><table border="0">
 302 <col align="left" valign="top">
 303 <tbody><tr>
 304 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 305 <td> a list of localized paper names.
 306
 307 </td>
 308 </tr></tbody>
 309 </table></div>
 310 </div>
 311 <hr>
 312 <div class="refsect2" title="lgl_db_free_paper_name_list ()">
 313 <a name="lgl-db-free-paper-name-list"></a><h3>lgl_db_free_paper_name_list ()</h3>
 314 <pre class="programlisting">void                lgl_db_free_paper_name_list         (<a
 315 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 316 >GList</a> *names);</pre>
 317 <p>
 318 Free up all storage associated with a name list obtained with
 319 <a class="link" href="libglabels-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>
 320 <p>
 321 </p>
 322 <div class="variablelist"><table border="0">
 323 <col align="left" valign="top">
 324 <tbody><tr>
 325 <td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
 326 <td> List of localized paper name strings to be freed.
 327 </td>
 328 </tr></tbody>
 329 </table></div>
 330 </div>
 331 <hr>
 332 <div class="refsect2" title="lgl_db_lookup_paper_from_id ()">
 333 <a name="lgl-db-lookup-paper-from-id"></a><h3>lgl_db_lookup_paper_from_id ()</h3>
 334 <pre class="programlisting"><a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          lgl_db_lookup_paper_from_id         (const <a
 335 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 336 >gchar</a> *id);</pre>
 337 <p>
 338 Lookup paper definition from id string.</p>
 339 <p>
 340 </p>
 341 <div class="variablelist"><table border="0">
 342 <col align="left" valign="top">
 343 <tbody>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 346 <td> paper id string
 347 </td>
 348 </tr>
 349 <tr>
 350 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 351 <td> pointer to a newly allocated <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper"><span class="type">lglPaper</span></a> structure.
 352
 353 </td>
 354 </tr>
 355 </tbody>
 356 </table></div>
 357 </div>
 358 <hr>
 359 <div class="refsect2" title="lgl_db_lookup_paper_from_name ()">
 360 <a name="lgl-db-lookup-paper-from-name"></a><h3>lgl_db_lookup_paper_from_name ()</h3>
 361 <pre class="programlisting"><a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          lgl_db_lookup_paper_from_name       (const <a
 362 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 363 >gchar</a> *name);</pre>
 364 <p>
 365 Lookup paper definition from localized paper name string.</p>
 366 <p>
 367 </p>
 368 <div class="variablelist"><table border="0">
 369 <col align="left" valign="top">
 370 <tbody>
 371 <tr>
 372 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 373 <td> localized paper name string
 374 </td>
 375 </tr>
 376 <tr>
 377 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 378 <td> pointer to a newly allocated <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper"><span class="type">lglPaper</span></a> structure.
 379
 380 </td>
 381 </tr>
 382 </tbody>
 383 </table></div>
 384 </div>
 385 <hr>
 386 <div class="refsect2" title="lgl_db_lookup_paper_id_from_name ()">
 387 <a name="lgl-db-lookup-paper-id-from-name"></a><h3>lgl_db_lookup_paper_id_from_name ()</h3>
 388 <pre class="programlisting"><a
 389 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 390 >gchar</a> *             lgl_db_lookup_paper_id_from_name    (const <a
 391 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 392 >gchar</a> *name);</pre>
 393 <p>
 394 Lookup paper name string from localized paper name string.</p>
 395 <p>
 396 </p>
 397 <div class="variablelist"><table border="0">
 398 <col align="left" valign="top">
 399 <tbody>
 400 <tr>
 401 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 402 <td> localized paper name stringp
 403 </td>
 404 </tr>
 405 <tr>
 406 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 407 <td> pointer to a newly allocated id string.
 408
 409 </td>
 410 </tr>
 411 </tbody>
 412 </table></div>
 413 </div>
 414 <hr>
 415 <div class="refsect2" title="lgl_db_lookup_paper_name_from_id ()">
 416 <a name="lgl-db-lookup-paper-name-from-id"></a><h3>lgl_db_lookup_paper_name_from_id ()</h3>
 417 <pre class="programlisting"><a
 418 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 419 >gchar</a> *             lgl_db_lookup_paper_name_from_id    (const <a
 420 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 421 >gchar</a> *id);</pre>
 422 <p>
 423 Lookup localized paper name string from paper id string.</p>
 424 <p>
 425 </p>
 426 <div class="variablelist"><table border="0">
 427 <col align="left" valign="top">
 428 <tbody>
 429 <tr>
 430 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 431 <td> paper id string
 432 </td>
 433 </tr>
 434 <tr>
 435 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 436 <td> pointer to a newly allocated localized paper name string.
 437
 438 </td>
 439 </tr>
 440 </tbody>
 441 </table></div>
 442 </div>
 443 <hr>
 444 <div class="refsect2" title="lgl_db_is_paper_id_known ()">
 445 <a name="lgl-db-is-paper-id-known"></a><h3>lgl_db_is_paper_id_known ()</h3>
 446 <pre class="programlisting"><a
 447 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 448 >gboolean</a>            lgl_db_is_paper_id_known            (const <a
 449 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 450 >gchar</a> *id);</pre>
 451 <p>
 452 Determine if given paper id is known to libglabels.</p>
 453 <p>
 454 </p>
 455 <div class="variablelist"><table border="0">
 456 <col align="left" valign="top">
 457 <tbody>
 458 <tr>
 459 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 460 <td> paper id to test
 461 </td>
 462 </tr>
 463 <tr>
 464 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 465 <td> TRUE if id is known, otherwise FALSE.
 466
 467 </td>
 468 </tr>
 469 </tbody>
 470 </table></div>
 471 </div>
 472 <hr>
 473 <div class="refsect2" title="lgl_db_is_paper_id_other ()">
 474 <a name="lgl-db-is-paper-id-other"></a><h3>lgl_db_is_paper_id_other ()</h3>
 475 <pre class="programlisting"><a
 476 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 477 >gboolean</a>            lgl_db_is_paper_id_other            (const <a
 478 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 479 >gchar</a> *id);</pre>
 480 <p>
 481 Determine if given paper id is the special id "Other."</p>
 482 <p>
 483 </p>
 484 <div class="variablelist"><table border="0">
 485 <col align="left" valign="top">
 486 <tbody>
 487 <tr>
 488 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 489 <td> paper id to test
 490 </td>
 491 </tr>
 492 <tr>
 493 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 494 <td> TRUE if id is "Other", otherwise FALSE.
 495
 496 </td>
 497 </tr>
 498 </tbody>
 499 </table></div>
 500 </div>
 501 <hr>
 502 <div class="refsect2" title="lgl_db_get_category_id_list ()">
 503 <a name="lgl-db-get-category-id-list"></a><h3>lgl_db_get_category_id_list ()</h3>
 504 <pre class="programlisting"><a
 505 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 506 >GList</a> *             lgl_db_get_category_id_list         (void);</pre>
 507 <p>
 508 Get a list of all category ids known to libglabels.</p>
 509 <p>
 510 </p>
 511 <div class="variablelist"><table border="0">
 512 <col align="left" valign="top">
 513 <tbody><tr>
 514 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 515 <td> a list of category ids.
 516
 517 </td>
 518 </tr></tbody>
 519 </table></div>
 520 </div>
 521 <hr>
 522 <div class="refsect2" title="lgl_db_free_category_id_list ()">
 523 <a name="lgl-db-free-category-id-list"></a><h3>lgl_db_free_category_id_list ()</h3>
 524 <pre class="programlisting">void                lgl_db_free_category_id_list        (<a
 525 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 526 >GList</a> *ids);</pre>
 527 <p>
 528 Free up all storage associated with an id list obtained with
 529 <a class="link" href="libglabels-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>
 530 <p>
 531 </p>
 532 <div class="variablelist"><table border="0">
 533 <col align="left" valign="top">
 534 <tbody><tr>
 535 <td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
 536 <td> List of id strings to be freed.
 537 </td>
 538 </tr></tbody>
 539 </table></div>
 540 </div>
 541 <hr>
 542 <div class="refsect2" title="lgl_db_get_category_name_list ()">
 543 <a name="lgl-db-get-category-name-list"></a><h3>lgl_db_get_category_name_list ()</h3>
 544 <pre class="programlisting"><a
 545 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 546 >GList</a> *             lgl_db_get_category_name_list       (void);</pre>
 547 <p>
 548 Get a list of all localized category names known to libglabels.</p>
 549 <p>
 550 </p>
 551 <div class="variablelist"><table border="0">
 552 <col align="left" valign="top">
 553 <tbody><tr>
 554 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 555 <td> a list of localized category names.
 556
 557 </td>
 558 </tr></tbody>
 559 </table></div>
 560 </div>
 561 <hr>
 562 <div class="refsect2" title="lgl_db_free_category_name_list ()">
 563 <a name="lgl-db-free-category-name-list"></a><h3>lgl_db_free_category_name_list ()</h3>
 564 <pre class="programlisting">void                lgl_db_free_category_name_list      (<a
 565 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 566 >GList</a> *names);</pre>
 567 <p>
 568 Free up all storage associated with a name list obtained with
 569 <a class="link" href="libglabels-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>
 570 <p>
 571 </p>
 572 <div class="variablelist"><table border="0">
 573 <col align="left" valign="top">
 574 <tbody><tr>
 575 <td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
 576 <td> List of localized category name strings to be freed.
 577 </td>
 578 </tr></tbody>
 579 </table></div>
 580 </div>
 581 <hr>
 582 <div class="refsect2" title="lgl_db_lookup_category_from_id ()">
 583 <a name="lgl-db-lookup-category-from-id"></a><h3>lgl_db_lookup_category_from_id ()</h3>
 584 <pre class="programlisting"><a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       lgl_db_lookup_category_from_id      (const <a
 585 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 586 >gchar</a> *id);</pre>
 587 <p>
 588 Lookup category definition from id string.</p>
 589 <p>
 590 </p>
 591 <div class="variablelist"><table border="0">
 592 <col align="left" valign="top">
 593 <tbody>
 594 <tr>
 595 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 596 <td> category id string
 597 </td>
 598 </tr>
 599 <tr>
 600 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 601 <td> pointer to a newly allocated <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.
 602
 603 </td>
 604 </tr>
 605 </tbody>
 606 </table></div>
 607 </div>
 608 <hr>
 609 <div class="refsect2" title="lgl_db_lookup_category_from_name ()">
 610 <a name="lgl-db-lookup-category-from-name"></a><h3>lgl_db_lookup_category_from_name ()</h3>
 611 <pre class="programlisting"><a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       lgl_db_lookup_category_from_name    (const <a
 612 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 613 >gchar</a> *name);</pre>
 614 <p>
 615 Lookup category definition from localized category name string.</p>
 616 <p>
 617 </p>
 618 <div class="variablelist"><table border="0">
 619 <col align="left" valign="top">
 620 <tbody>
 621 <tr>
 622 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 623 <td> localized category name string
 624 </td>
 625 </tr>
 626 <tr>
 627 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 628 <td> pointer to a newly allocated <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.
 629
 630 </td>
 631 </tr>
 632 </tbody>
 633 </table></div>
 634 </div>
 635 <hr>
 636 <div class="refsect2" title="lgl_db_lookup_category_id_from_name ()">
 637 <a name="lgl-db-lookup-category-id-from-name"></a><h3>lgl_db_lookup_category_id_from_name ()</h3>
 638 <pre class="programlisting"><a
 639 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 640 >gchar</a> *             lgl_db_lookup_category_id_from_name (const <a
 641 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 642 >gchar</a> *name);</pre>
 643 <p>
 644 Lookup category name string from localized category name string.</p>
 645 <p>
 646 </p>
 647 <div class="variablelist"><table border="0">
 648 <col align="left" valign="top">
 649 <tbody>
 650 <tr>
 651 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 652 <td> localized category name stringp
 653 </td>
 654 </tr>
 655 <tr>
 656 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 657 <td> pointer to a newly allocated id string.
 658
 659 </td>
 660 </tr>
 661 </tbody>
 662 </table></div>
 663 </div>
 664 <hr>
 665 <div class="refsect2" title="lgl_db_lookup_category_name_from_id ()">
 666 <a name="lgl-db-lookup-category-name-from-id"></a><h3>lgl_db_lookup_category_name_from_id ()</h3>
 667 <pre class="programlisting"><a
 668 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 669 >gchar</a> *             lgl_db_lookup_category_name_from_id (const <a
 670 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 671 >gchar</a> *id);</pre>
 672 <p>
 673 Lookup localized category name string from category id string.</p>
 674 <p>
 675 </p>
 676 <div class="variablelist"><table border="0">
 677 <col align="left" valign="top">
 678 <tbody>
 679 <tr>
 680 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 681 <td> category id string
 682 </td>
 683 </tr>
 684 <tr>
 685 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 686 <td> pointer to a newly allocated localized category name string.
 687
 688 </td>
 689 </tr>
 690 </tbody>
 691 </table></div>
 692 </div>
 693 <hr>
 694 <div class="refsect2" title="lgl_db_is_category_id_known ()">
 695 <a name="lgl-db-is-category-id-known"></a><h3>lgl_db_is_category_id_known ()</h3>
 696 <pre class="programlisting"><a
 697 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 698 >gboolean</a>            lgl_db_is_category_id_known         (const <a
 699 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 700 >gchar</a> *id);</pre>
 701 <p>
 702 Determine if given category id is known to libglabels.</p>
 703 <p>
 704 </p>
 705 <div class="variablelist"><table border="0">
 706 <col align="left" valign="top">
 707 <tbody>
 708 <tr>
 709 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 710 <td> category id to test
 711 </td>
 712 </tr>
 713 <tr>
 714 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 715 <td> TRUE if id is known, otherwise FALSE.
 716
 717 </td>
 718 </tr>
 719 </tbody>
 720 </table></div>
 721 </div>
 722 <hr>
 723 <div class="refsect2" title="lgl_db_get_brand_list ()">
 724 <a name="lgl-db-get-brand-list"></a><h3>lgl_db_get_brand_list ()</h3>
 725 <pre class="programlisting"><a
 726 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 727 >GList</a> *             lgl_db_get_brand_list               (const <a
 728 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 729 >gchar</a> *paper_id,
 730                                                          const <a
 731 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 732 >gchar</a> *category_id);</pre>
 733 <p>
 734 Get a list of all valid brands of templates in the template database.
 735 Results can be filtered by page size and/or template category.  A list of valid page
 736 sizes can be obtained using <a class="link" href="libglabels-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
 737 categories can be obtained using <a class="link" href="libglabels-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>
 738 <p>
 739 </p>
 740 <div class="variablelist"><table border="0">
 741 <col align="left" valign="top">
 742 <tbody>
 743 <tr>
 744 <td><p><span class="term"><em class="parameter"><code>paper_id</code></em> :</span></p></td>
 745 <td> If non NULL, limit results to given page size.
 746 </td>
 747 </tr>
 748 <tr>
 749 <td><p><span class="term"><em class="parameter"><code>category_id</code></em> :</span></p></td>
 750 <td> If non NULL, limit results to given template category.
 751 </td>
 752 </tr>
 753 <tr>
 754 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 755 <td> a list of brands
 756 </td>
 757 </tr>
 758 </tbody>
 759 </table></div>
 760 </div>
 761 <hr>
 762 <div class="refsect2" title="lgl_db_free_brand_list ()">
 763 <a name="lgl-db-free-brand-list"></a><h3>lgl_db_free_brand_list ()</h3>
 764 <pre class="programlisting">void                lgl_db_free_brand_list              (<a
 765 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 766 >GList</a> *brands);</pre>
 767 <p>
 768 Free up all storage associated with a list of template names obtained with
 769 <a class="link" href="libglabels-db.html#lgl-db-get-brand-list" title="lgl_db_get_brand_list ()"><code class="function">lgl_db_get_brand_list()</code></a>.</p>
 770 <p>
 771 </p>
 772 <div class="variablelist"><table border="0">
 773 <col align="left" valign="top">
 774 <tbody><tr>
 775 <td><p><span class="term"><em class="parameter"><code>brands</code></em> :</span></p></td>
 776 <td> List of template brand strings to be freed.
 777 </td>
 778 </tr></tbody>
 779 </table></div>
 780 </div>
 781 <hr>
 782 <div class="refsect2" title="lgl_db_register_template ()">
 783 <a name="lgl-db-register-template"></a><h3>lgl_db_register_template ()</h3>
 784 <pre class="programlisting"><a class="link" href="libglabels-db.html#lglDbRegStatus" title="enum lglDbRegStatus">lglDbRegStatus</a>      lgl_db_register_template            (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);</pre>
 785 <p>
 786 Register a template.  This function adds a template to the template database.
 787 The template will be stored in an individual XML file in the user template directory.</p>
 788 <p>
 789 </p>
 790 <div class="variablelist"><table border="0">
 791 <col align="left" valign="top">
 792 <tbody>
 793 <tr>
 794 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
 795 <td>  Pointer to a template structure to add to database.
 796 </td>
 797 </tr>
 798 <tr>
 799 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 800 <td> Status of registration attempt (<a class="link" href="libglabels-db.html#lglDbRegStatus" title="enum lglDbRegStatus"><span class="type">lglDbRegStatus</span></a>)
 801 </td>
 802 </tr>
 803 </tbody>
 804 </table></div>
 805 </div>
 806 <hr>
 807 <div class="refsect2" title="lgl_db_does_template_exist ()">
 808 <a name="lgl-db-does-template-exist"></a><h3>lgl_db_does_template_exist ()</h3>
 809 <pre class="programlisting"><a
 810 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 811 >gboolean</a>            lgl_db_does_template_exist          (const <a
 812 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 813 >gchar</a> *brand,
 814                                                          const <a
 815 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 816 >gchar</a> *part);</pre>
 817 <p>
 818 This function tests whether a template with the given brand and part name/number exists.</p>
 819 <p>
 820 </p>
 821 <div class="variablelist"><table border="0">
 822 <col align="left" valign="top">
 823 <tbody>
 824 <tr>
 825 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
 826 <td> Brand name.
 827 </td>
 828 </tr>
 829 <tr>
 830 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
 831 <td>  Part name/number.
 832 </td>
 833 </tr>
 834 <tr>
 835 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 836 <td>  TRUE if such a template exists in the database.
 837 </td>
 838 </tr>
 839 </tbody>
 840 </table></div>
 841 </div>
 842 <hr>
 843 <div class="refsect2" title="lgl_db_does_template_name_exist ()">
 844 <a name="lgl-db-does-template-name-exist"></a><h3>lgl_db_does_template_name_exist ()</h3>
 845 <pre class="programlisting"><a
 846 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
 847 >gboolean</a>            lgl_db_does_template_name_exist     (const <a
 848 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 849 >gchar</a> *name);</pre>
 850 <p>
 851 This function test whether a template with the given name exists.</p>
 852 <p>
 853 </p>
 854 <div class="variablelist"><table border="0">
 855 <col align="left" valign="top">
 856 <tbody>
 857 <tr>
 858 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 859 <td> name string
 860 </td>
 861 </tr>
 862 <tr>
 863 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 864 <td> TRUE if such a template exists in the database.
 865
 866 </td>
 867 </tr>
 868 </tbody>
 869 </table></div>
 870 </div>
 871 <hr>
 872 <div class="refsect2" title="lgl_db_get_template_name_list_unique ()">
 873 <a name="lgl-db-get-template-name-list-unique"></a><h3>lgl_db_get_template_name_list_unique ()</h3>
 874 <pre class="programlisting"><a
 875 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 876 >GList</a> *             lgl_db_get_template_name_list_unique
 877                                                         (const <a
 878 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 879 >gchar</a> *brand,
 880                                                          const <a
 881 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 882 >gchar</a> *paper_id,
 883                                                          const <a
 884 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 885 >gchar</a> *category_id);</pre>
 886 <p>
 887 Get a list of valid names of unique templates in the template database.  Results
 888 can be filtered by page size and/or template category.  A list of valid page sizes
 889 can be obtained using <a class="link" href="libglabels-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 categories
 890 can be obtained using <a class="link" href="libglabels-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>.
 891 </p>
 892 <p>
 893 This function differs from <a class="link" href="libglabels-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>, because it does not
 894 return multiple names for the same template.</p>
 895 <p>
 896 </p>
 897 <div class="variablelist"><table border="0">
 898 <col align="left" valign="top">
 899 <tbody>
 900 <tr>
 901 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
 902 <td>     If non NULL, limit results to given brand
 903 </td>
 904 </tr>
 905 <tr>
 906 <td><p><span class="term"><em class="parameter"><code>paper_id</code></em> :</span></p></td>
 907 <td> If non NULL, limit results to given page size.
 908 </td>
 909 </tr>
 910 <tr>
 911 <td><p><span class="term"><em class="parameter"><code>category_id</code></em> :</span></p></td>
 912 <td> If non NULL, limit results to given template category.
 913 </td>
 914 </tr>
 915 <tr>
 916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 917 <td> a list of template names.
 918 </td>
 919 </tr>
 920 </tbody>
 921 </table></div>
 922 </div>
 923 <hr>
 924 <div class="refsect2" title="lgl_db_get_template_name_list_all ()">
 925 <a name="lgl-db-get-template-name-list-all"></a><h3>lgl_db_get_template_name_list_all ()</h3>
 926 <pre class="programlisting"><a
 927 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 928 >GList</a> *             lgl_db_get_template_name_list_all   (const <a
 929 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 930 >gchar</a> *brand,
 931                                                          const <a
 932 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 933 >gchar</a> *paper_id,
 934                                                          const <a
 935 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 936 >gchar</a> *category_id);</pre>
 937 <p>
 938 Get a list of all valid names and aliases of templates in the template database.
 939 Results can be filtered by page size and/or template category.  A list of valid page
 940 sizes can be obtained using <a class="link" href="libglabels-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
 941 categories can be obtained using <a class="link" href="libglabels-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>.
 942 </p>
 943 <p>
 944 This function differs from <a class="link" href="libglabels-db.html#lgl-db-get-template-name-list-unique" title="lgl_db_get_template_name_list_unique ()"><code class="function">lgl_db_get_template_name_list_unique()</code></a>, because it will
 945 return multiple names for the same template.</p>
 946 <p>
 947 </p>
 948 <div class="variablelist"><table border="0">
 949 <col align="left" valign="top">
 950 <tbody>
 951 <tr>
 952 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
 953 <td>     If non NULL, limit results to given brand
 954 </td>
 955 </tr>
 956 <tr>
 957 <td><p><span class="term"><em class="parameter"><code>paper_id</code></em> :</span></p></td>
 958 <td> If non NULL, limit results to given page size.
 959 </td>
 960 </tr>
 961 <tr>
 962 <td><p><span class="term"><em class="parameter"><code>category_id</code></em> :</span></p></td>
 963 <td> If non NULL, limit results to given template category.
 964 </td>
 965 </tr>
 966 <tr>
 967 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 968 <td> a list of template names and aliases.
 969 </td>
 970 </tr>
 971 </tbody>
 972 </table></div>
 973 </div>
 974 <hr>
 975 <div class="refsect2" title="lgl_db_free_template_name_list ()">
 976 <a name="lgl-db-free-template-name-list"></a><h3>lgl_db_free_template_name_list ()</h3>
 977 <pre class="programlisting">void                lgl_db_free_template_name_list      (<a
 978 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 979 >GList</a> *names);</pre>
 980 <p>
 981 Free up all storage associated with a list of template names obtained with
 982 <a class="link" href="libglabels-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> or <a class="link" href="libglabels-db.html#lgl-db-get-template-name-list-unique" title="lgl_db_get_template_name_list_unique ()"><code class="function">lgl_db_get_template_name_list_unique()</code></a>.</p>
 983 <p>
 984 </p>
 985 <div class="variablelist"><table border="0">
 986 <col align="left" valign="top">
 987 <tbody><tr>
 988 <td><p><span class="term"><em class="parameter"><code>names</code></em> :</span></p></td>
 989 <td> List of template name strings to be freed.
 990 </td>
 991 </tr></tbody>
 992 </table></div>
 993 </div>
 994 <hr>
 995 <div class="refsect2" title="lgl_db_lookup_template_from_name ()">
 996 <a name="lgl-db-lookup-template-from-name"></a><h3>lgl_db_lookup_template_from_name ()</h3>
 997 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       lgl_db_lookup_template_from_name    (const <a
 998 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 999 >gchar</a> *name);</pre>
1000 <p>
1001 Lookup template in template database from name string.</p>
1002 <p>
1003 </p>
1004 <div class="variablelist"><table border="0">
1005 <col align="left" valign="top">
1006 <tbody>
1007 <tr>
1008 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1009 <td> name string
1010 </td>
1011 </tr>
1012 <tr>
1013 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1014 <td> pointer to a newly allocated <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure.
1015
1016 </td>
1017 </tr>
1018 </tbody>
1019 </table></div>
1020 </div>
1021 <hr>
1022 <div class="refsect2" title="lgl_db_print_known_papers ()">
1023 <a name="lgl-db-print-known-papers"></a><h3>lgl_db_print_known_papers ()</h3>
1024 <pre class="programlisting">void                lgl_db_print_known_papers           (void);</pre>
1025 <p>
1026 For debugging purposes: print a list of all paper definitions known to
1027 libglabels.</p>
1028 <p>
1029 </p>
1030 </div>
1031 <hr>
1032 <div class="refsect2" title="lgl_db_print_known_categories ()">
1033 <a name="lgl-db-print-known-categories"></a><h3>lgl_db_print_known_categories ()</h3>
1034 <pre class="programlisting">void                lgl_db_print_known_categories       (void);</pre>
1035 <p>
1036 For debugging purposes: print a list of all category definitions known to
1037 libglabels.</p>
1038 <p>
1039 </p>
1040 </div>
1041 <hr>
1042 <div class="refsect2" title="lgl_db_print_known_templates ()">
1043 <a name="lgl-db-print-known-templates"></a><h3>lgl_db_print_known_templates ()</h3>
1044 <pre class="programlisting">void                lgl_db_print_known_templates        (void);</pre>
1045 <p>
1046 Print all known templates (for debugging purposes).</p>
1047 <p>
1048 </p>
1049 </div>
1050 <hr>
1051 <div class="refsect2" title="lgl_db_print_aliases ()">
1052 <a name="lgl-db-print-aliases"></a><h3>lgl_db_print_aliases ()</h3>
1053 <pre class="programlisting">void                lgl_db_print_aliases                (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);</pre>
1054 <p>
1055 Print all aliases of a template (for debugging purposes).</p>
1056 <p>
1057 </p>
1058 <div class="variablelist"><table border="0">
1059 <col align="left" valign="top">
1060 <tbody><tr>
1061 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1062 <td> template
1063 </td>
1064 </tr></tbody>
1065 </table></div>
1066 </div>
1067 </div>
1068 </div>
1069 <div class="footer">
1070 <hr>
1071           Generated by GTK-Doc V1.11</div>
1072 </body>
1073 </html>