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 <!-- ##### SECTION Image ##### -->
  22
  23
  24 <!-- ##### ENUM lglDbRegStatus ##### -->
  25 <para>
  26 This enumeration defines a set of possible return values for lgl_db_register_template().
  27 </para>
  28
  29 @LGL_DB_REG_OK: Registration successful.
  30 @LGL_DB_REG_BAD_PAPER_ID:  Registration failed because paper id is unknown.
  31 @LGL_DB_REG_BRAND_PART_EXISTS: Registration failed because template with same brand and part name/number already exists.
  32 @LGL_DB_REG_FILE_WRITE_ERROR: Registration failed because an error while writing to disk.
  33
  34 <!-- ##### ENUM lglDbDeleteStatus ##### -->
  35 <para>
  36 This enumeration defines a set of possible return values for lgl_db_delete_template_by_name() or lgl_db_delete_template_by_brand_part().
  37 </para>
  38
  39 @LGL_DB_DELETE_OK: Deletion successful.
  40 @LGL_DB_DELETE_DOES_NOT_EXIST: Deletion failed because template with given brand and part name/number does not exist.
  41 @LGL_DB_DELETE_NOT_USER_DEFINED: Deletion failed because given template is not a user defined template.
  42 @LGL_DB_DELETE_FILE_ERROR: Deletion failed because of an error while attempting to remove template from disk.
  43
  44 <!-- ##### FUNCTION lgl_db_init ##### -->
  45 <para>
  46
  47 </para>
  48
  49 @void:
  50
  51
  52 <!-- ##### USER_FUNCTION lglDbNotifyFunc ##### -->
  53 <para>
  54 Defines the type of notify callback function to be called when database changes.
  55 </para>
  56
  57 @user_data: Pointer to user data that is passed to the notify function.
  58
  59
  60 <!-- ##### FUNCTION lgl_db_notify_add ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @func:
  66 @user_data:
  67 @Returns:
  68
  69
  70 <!-- ##### FUNCTION lgl_db_notify_remove ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @id:
  76
  77
  78 <!-- ##### FUNCTION lgl_db_get_paper_id_list ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @void:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION lgl_db_free_paper_id_list ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @ids:
  93
  94
  95 <!-- ##### FUNCTION lgl_db_get_paper_name_list ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @void:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION lgl_db_free_paper_name_list ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @names:
 110
 111
 112 <!-- ##### FUNCTION lgl_db_lookup_paper_from_id ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @id:
 118 @Returns:
 119
 120
 121 <!-- ##### FUNCTION lgl_db_lookup_paper_from_name ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @name:
 127 @Returns:
 128
 129
 130 <!-- ##### FUNCTION lgl_db_lookup_paper_id_from_name ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @name:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION lgl_db_lookup_paper_name_from_id ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @id:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION lgl_db_is_paper_id_known ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @id:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION lgl_db_is_paper_id_other ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @id:
 163 @Returns:
 164
 165
 166 <!-- ##### FUNCTION lgl_db_get_category_id_list ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @void:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION lgl_db_free_category_id_list ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @ids:
 181
 182
 183 <!-- ##### FUNCTION lgl_db_get_category_name_list ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @void:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION lgl_db_free_category_name_list ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @names:
 198
 199
 200 <!-- ##### FUNCTION lgl_db_lookup_category_from_id ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @id:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION lgl_db_lookup_category_from_name ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @name:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION lgl_db_lookup_category_id_from_name ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @name:
 224 @Returns:
 225
 226
 227 <!-- ##### FUNCTION lgl_db_lookup_category_name_from_id ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @id:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION lgl_db_is_category_id_known ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @id:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION lgl_db_get_brand_list ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @paper_id:
 251 @category_id:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION lgl_db_free_brand_list ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @brands:
 261
 262
 263 <!-- ##### FUNCTION lgl_db_register_template ##### -->
 264 <para>
 265
 266 </para>
 267
 268 @template:
 269 @Returns:
 270
 271
 272 <!-- ##### FUNCTION lgl_db_delete_template_by_brand_part ##### -->
 273 <para>
 274
 275 </para>
 276
 277 @brand:
 278 @part:
 279 @Returns:
 280
 281
 282 <!-- ##### FUNCTION lgl_db_delete_template_by_name ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @name:
 288 @Returns:
 289
 290
 291 <!-- ##### FUNCTION lgl_db_does_template_exist ##### -->
 292 <para>
 293
 294 </para>
 295
 296 @brand:
 297 @part:
 298 @Returns:
 299
 300
 301 <!-- ##### FUNCTION lgl_db_does_template_name_exist ##### -->
 302 <para>
 303
 304 </para>
 305
 306 @name:
 307 @Returns:
 308
 309
 310 <!-- ##### FUNCTION lgl_db_get_template_name_list_all ##### -->
 311 <para>
 312
 313 </para>
 314
 315 @brand:
 316 @paper_id:
 317 @category_id:
 318 @Returns:
 319
 320
 321 <!-- ##### FUNCTION lgl_db_get_similar_template_name_list ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @name:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION lgl_db_free_template_name_list ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @names:
 336
 337
 338 <!-- ##### FUNCTION lgl_db_lookup_template_from_name ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @name:
 344 @Returns:
 345
 346
 347 <!-- ##### FUNCTION lgl_db_lookup_template_from_brand_part ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @brand:
 353 @part:
 354 @Returns:
 355
 356
 357 <!-- ##### FUNCTION lgl_db_get_vendor_name_list ##### -->
 358 <para>
 359
 360 </para>
 361
 362 @void:
 363 @Returns:
 364
 365
 366 <!-- ##### FUNCTION lgl_db_free_vendor_name_list ##### -->
 367 <para>
 368
 369 </para>
 370
 371 @names:
 372
 373
 374 <!-- ##### FUNCTION lgl_db_is_vendor_name_known ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @name:
 380 @Returns:
 381
 382
 383 <!-- ##### FUNCTION lgl_db_lookup_vendor_from_name ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @name:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION lgl_db_print_known_papers ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @void:
 398
 399
 400 <!-- ##### FUNCTION lgl_db_print_known_categories ##### -->
 401 <para>
 402
 403 </para>
 404
 405 @void:
 406
 407
 408 <!-- ##### FUNCTION lgl_db_print_known_templates ##### -->
 409 <para>
 410
 411 </para>
 412
 413 @void:
 414
 415
 416 <!-- ##### FUNCTION lgl_db_print_known_vendors ##### -->
 417 <para>
 418
 419 </para>
 420
 421 @void:
 422
 423