git.sur5r.net Git - glabels/blob - docs/libglabels/tmpl/db.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Database
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Database of pre-defined templates
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This section describes a set of functions to locate and add templates and related information in
  10 the LibGlabels template database.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### SECTION Stability_Level ##### -->
  19
  20
  21 <!-- ##### ENUM lglDbRegStatus ##### -->
  22 <para>
  23 This enumeration defines a set of possible return values for lgl_db_register_template().
  24 </para>
  25
  26 @LGL_DB_REG_OK: Registration successful.
  27 @LGL_DB_REG_BAD_PAPER_ID:  Registration failed because paper id is unknown.
  28 @LGL_DB_REG_BRAND_PART_EXISTS: Registration failed because template with same brand and part name/number already exists.
  29 @LGL_DB_REG_FILE_WRITE_ERROR: Registration failed because an error while writing to disk.
  30
  31 <!-- ##### FUNCTION lgl_db_init ##### -->
  32 <para>
  33
  34 </para>
  35
  36
  37
  38 <!-- ##### FUNCTION lgl_db_get_paper_id_list ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @Returns:
  44
  45
  46 <!-- ##### FUNCTION lgl_db_free_paper_id_list ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @ids:
  52
  53
  54 <!-- ##### FUNCTION lgl_db_get_paper_name_list ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @Returns:
  60
  61
  62 <!-- ##### FUNCTION lgl_db_free_paper_name_list ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @names:
  68
  69
  70 <!-- ##### FUNCTION lgl_db_lookup_paper_from_id ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @id:
  76 @Returns:
  77
  78
  79 <!-- ##### FUNCTION lgl_db_lookup_paper_from_name ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @name:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION lgl_db_lookup_paper_id_from_name ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @name:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION lgl_db_lookup_paper_name_from_id ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @id:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION lgl_db_is_paper_id_known ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @id:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION lgl_db_is_paper_id_other ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @id:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION lgl_db_get_category_id_list ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @Returns:
 130
 131
 132 <!-- ##### FUNCTION lgl_db_free_category_id_list ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @ids:
 138
 139
 140 <!-- ##### FUNCTION lgl_db_get_category_name_list ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION lgl_db_free_category_name_list ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @names:
 154
 155
 156 <!-- ##### FUNCTION lgl_db_lookup_category_from_id ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @id:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION lgl_db_lookup_category_from_name ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @name:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION lgl_db_lookup_category_id_from_name ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @name:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION lgl_db_lookup_category_name_from_id ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @id:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION lgl_db_is_category_id_known ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @id:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION lgl_db_get_brand_list ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @paper_id:
 207 @category_id:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION lgl_db_free_brand_list ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @brands:
 217
 218
 219 <!-- ##### FUNCTION lgl_db_register_template ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @template:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION lgl_db_does_template_exist ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @brand:
 234 @part:
 235 @Returns:
 236
 237
 238 <!-- ##### FUNCTION lgl_db_does_template_name_exist ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @name:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION lgl_db_get_template_name_list_unique ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @brand:
 253 @paper_id:
 254 @category_id:
 255 @Returns:
 256
 257
 258 <!-- ##### FUNCTION lgl_db_get_template_name_list_all ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @brand:
 264 @paper_id:
 265 @category_id:
 266 @Returns:
 267
 268
 269 <!-- ##### FUNCTION lgl_db_free_template_name_list ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @names:
 275
 276
 277 <!-- ##### FUNCTION lgl_db_lookup_template_from_name ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @name:
 283 @Returns:
 284
 285
 286 <!-- ##### FUNCTION lgl_db_print_known_papers ##### -->
 287 <para>
 288
 289 </para>
 290
 291
 292
 293 <!-- ##### FUNCTION lgl_db_print_known_categories ##### -->
 294 <para>
 295
 296 </para>
 297
 298
 299
 300 <!-- ##### FUNCTION lgl_db_print_known_templates ##### -->
 301 <para>
 302
 303 </para>
 304
 305
 306
 307 <!-- ##### FUNCTION lgl_db_print_aliases ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @template:
 313
 314