X-Git-Url: https://git.sur5r.net/?p=glabels;a=blobdiff_plain;f=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-db.html;h=628d5f3084ed56d5897e11390452ab48049eb8ba;hp=d0d988ed6e675d06cce5acca27798c44b22bca1c;hb=0be9b6d8653b1020e466541b890e97a03590f83b;hpb=8e4c50283c4f353b18c68474f91209b8bd050557 diff --git a/docs/libglabels/html/libglabels-3.0-db.html b/docs/libglabels/html/libglabels-3.0-db.html index d0d988ed..628d5f30 100644 --- a/docs/libglabels/html/libglabels-3.0-db.html +++ b/docs/libglabels/html/libglabels-3.0-db.html @@ -2,21 +2,20 @@ -LibGlabels 3.0 Reference Manual: Database +Database: LibGlabels 3.0 Reference Manual - + - + @@ -58,7 +57,7 @@
-

Object Hierarchy

-
-
-
-

Includes

#include <libglabels/lgl-db.h>
@@ -441,12 +435,12 @@ this data.

lglDbNotifyFunc ()

void
-(*lglDbNotifyFunc) (gpointer user_data);
+(*lglDbNotifyFunc) (gpointer user_data);

Defines the type of notify callback function to be called when database changes.

-

Parameters

+

Parameters

@@ -464,12 +458,12 @@ Defines the type of notify callback function to be called when database changes.

lgl_db_notify_add ()

-
gulong
+
gulong
 lgl_db_notify_add (lglDbNotifyFunc func,
-                   gpointer user_data);

+                   gpointer user_data);

Register a notification callback function to be called when the database changes.

-

Parameters

+

Parameters

@@ -491,19 +485,18 @@ lgl_db_notify_add ( -

Returns

+

Returns

an ID for this notification registration.

-

lgl_db_notify_remove ()

void
-lgl_db_notify_remove (gulong id);
+lgl_db_notify_remove (gulong id);

Cancel a previous registration a notification callback function.

-

Parameters

+

Parameters

@@ -521,24 +514,23 @@ lgl_db_notify_remove (

lgl_db_get_paper_id_list ()

-
GList *
+
GList *
 lgl_db_get_paper_id_list (void);

 
Get a list of all paper ids known to libglabels.

 

-
Returns

+
Returns

 
 a list of paper ids.

-

 

 
 

 

 
lgl_db_free_paper_id_list ()

 
void
-lgl_db_free_paper_id_list (GList *ids);

+lgl_db_free_paper_id_list (GList *ids);

Free up all storage associated with an id list obtained with lgl_db_get_paper_id_list().

-

Parameters

+

Parameters

@@ -556,24 +548,23 @@ lgl_db_free_paper_id_list (

lgl_db_get_paper_name_list ()

-
GList *
+
GList *
 lgl_db_get_paper_name_list (void);

 
Get a list of all localized paper names known to libglabels.

 

-
Returns

+
Returns

 
 a list of localized paper names.

-

 

 
 

 

 
lgl_db_free_paper_name_list ()

 
void
-lgl_db_free_paper_name_list (GList *names);

+lgl_db_free_paper_name_list (GList *names);

Free up all storage associated with a name list obtained with lgl_db_get_paper_name_list().

-

Parameters

+

Parameters

@@ -592,10 +583,10 @@ lgl_db_free_paper_name_list (

lgl_db_lookup_paper_from_id ()

lglPaper *
-lgl_db_lookup_paper_from_id (const gchar *id);
+lgl_db_lookup_paper_from_id (const gchar *id);

Lookup paper definition from id string.

-

Parameters

+

Parameters

@@ -610,19 +601,18 @@ lgl_db_lookup_paper_from_id (const -

Returns

+

Returns

pointer to a newly allocated lglPaper structure.

-

lgl_db_lookup_paper_from_name ()

lglPaper *
-lgl_db_lookup_paper_from_name (const gchar *name);
+lgl_db_lookup_paper_from_name (const gchar *name);

Lookup paper definition from localized paper name string.

-

Parameters

+

Parameters

@@ -637,19 +627,18 @@ lgl_db_lookup_paper_from_name (const -

Returns

+

Returns

pointer to a newly allocated lglPaper structure.

-

lgl_db_lookup_paper_id_from_name ()

-
gchar *
-lgl_db_lookup_paper_id_from_name (const gchar *name);
+
gchar *
+lgl_db_lookup_paper_id_from_name (const gchar *name);

Lookup paper name string from localized paper name string.

-

Parameters

+

Parameters

@@ -664,19 +653,18 @@ lgl_db_lookup_paper_id_from_name (const -

Returns

+

Returns

pointer to a newly allocated id string.

-

lgl_db_lookup_paper_name_from_id ()

-
gchar *
-lgl_db_lookup_paper_name_from_id (const gchar *id);
+
gchar *
+lgl_db_lookup_paper_name_from_id (const gchar *id);

Lookup localized paper name string from paper id string.

-

Parameters

+

Parameters

@@ -691,19 +679,18 @@ lgl_db_lookup_paper_name_from_id (const -

Returns

+

Returns

pointer to a newly allocated localized paper name string.

-

lgl_db_is_paper_id_known ()

-
gboolean
-lgl_db_is_paper_id_known (const gchar *id);
+
gboolean
+lgl_db_is_paper_id_known (const gchar *id);

Determine if given paper id is known to libglabels.

-

Parameters

+

Parameters

@@ -718,19 +705,18 @@ lgl_db_is_paper_id_known (const -

Returns

+

Returns

TRUE if id is known, otherwise FALSE.

-

lgl_db_is_paper_id_other ()

-
gboolean
-lgl_db_is_paper_id_other (const gchar *id);
+
gboolean
+lgl_db_is_paper_id_other (const gchar *id);

Determine if given paper id is the special id "Other."

-

Parameters

+

Parameters

@@ -745,32 +731,30 @@ lgl_db_is_paper_id_other (const -

Returns

+

Returns

TRUE if id is "Other", otherwise FALSE.

-

lgl_db_get_category_id_list ()

-
GList *
+
GList *
 lgl_db_get_category_id_list (void);

 
Get a list of all category ids known to libglabels.

 

-
Returns

+
Returns

 
 a list of category ids.

-

lgl_db_free_category_id_list ()

void
-lgl_db_free_category_id_list (GList *ids);
+lgl_db_free_category_id_list (GList *ids);

Free up all storage associated with an id list obtained with lgl_db_get_category_id_list().

-

Parameters

+

Parameters

@@ -788,24 +772,23 @@ lgl_db_free_category_id_list (

lgl_db_get_category_name_list ()

-
GList *
+
GList *
 lgl_db_get_category_name_list (void);

 
Get a list of all localized category names known to libglabels.

 

-
Returns

+
Returns

 
 a list of localized category names.

-

 

 
 

 

 
lgl_db_free_category_name_list ()

 
void
-lgl_db_free_category_name_list (GList *names);

+lgl_db_free_category_name_list (GList *names);

Free up all storage associated with a name list obtained with lgl_db_get_category_name_list().

-

Parameters

+

Parameters

@@ -824,10 +807,10 @@ lgl_db_free_category_name_list (

lgl_db_lookup_category_from_id ()

lglCategory *
-lgl_db_lookup_category_from_id (const gchar *id);
+lgl_db_lookup_category_from_id (const gchar *id);

Lookup category definition from id string.

-

Parameters

+

Parameters

@@ -842,19 +825,18 @@ lgl_db_lookup_category_from_id (const -

Returns

+

Returns

pointer to a newly allocated lglCategory structure.

-

lgl_db_lookup_category_from_name ()

lglCategory *
-lgl_db_lookup_category_from_name (const gchar *name);
+lgl_db_lookup_category_from_name (const gchar *name);

Lookup category definition from localized category name string.

-

Parameters

+

Parameters

@@ -869,19 +851,18 @@ lgl_db_lookup_category_from_name (const -

Returns

+

Returns

pointer to a newly allocated lglCategory structure.

-

lgl_db_lookup_category_id_from_name ()

-
gchar *
-lgl_db_lookup_category_id_from_name (const gchar *name);
+
gchar *
+lgl_db_lookup_category_id_from_name (const gchar *name);

Lookup category name string from localized category name string.

-

Parameters

+

Parameters

@@ -896,19 +877,18 @@ lgl_db_lookup_category_id_from_name (const -

Returns

+

Returns

pointer to a newly allocated id string.

-

lgl_db_lookup_category_name_from_id ()

-
gchar *
-lgl_db_lookup_category_name_from_id (const gchar *id);
+
gchar *
+lgl_db_lookup_category_name_from_id (const gchar *id);

Lookup localized category name string from category id string.

-

Parameters

+

Parameters

@@ -923,19 +903,18 @@ lgl_db_lookup_category_name_from_id (const -

Returns

+

Returns

pointer to a newly allocated localized category name string.

-

lgl_db_is_category_id_known ()

-
gboolean
-lgl_db_is_category_id_known (const gchar *id);
+
gboolean
+lgl_db_is_category_id_known (const gchar *id);

Determine if given category id is known to libglabels.

-

Parameters

+

Parameters

@@ -950,23 +929,22 @@ lgl_db_is_category_id_known (const -

Returns

+

Returns

TRUE if id is known, otherwise FALSE.

-

lgl_db_get_brand_list ()

-
GList *
-lgl_db_get_brand_list (const gchar *paper_id,
-                       const gchar *category_id);
+
GList *
+lgl_db_get_brand_list (const gchar *paper_id,
+                       const gchar *category_id);

Get a list of all valid brands of templates in the template database. Results can be filtered by page size and/or template category. A list of valid page sizes can be obtained using lgl_db_get_paper_id_list(). A list of valid template categories can be obtained using lgl_db_get_category_id_list().

-

Parameters

+

Parameters

@@ -988,20 +966,19 @@ categories can be obtained using -

Returns

+

Returns

a list of brands

-

lgl_db_free_brand_list ()

void
-lgl_db_free_brand_list (GList *brands);
+lgl_db_free_brand_list (GList *brands);

Free up all storage associated with a list of template names obtained with lgl_db_get_brand_list().

-

Parameters

+

Parameters

@@ -1024,7 +1001,7 @@ lgl_db_register_template (const Register a template. This function adds a template to the template database. The template will be stored in an individual XML file in the user template directory.

-

Parameters

+

Parameters

@@ -1039,22 +1016,21 @@ The template will be stored in an individual XML file in the user template direc
-

Returns

+

Returns

Status of registration attempt (lglDbRegStatus)

-

lgl_db_delete_template_by_brand_part ()

lglDbDeleteStatus
-lgl_db_delete_template_by_brand_part (const gchar *brand,
-                                      const gchar *part);
+lgl_db_delete_template_by_brand_part (const gchar *brand, + const gchar *part);

Delete a user defined template. This function deletes a template from the template database. The individual XML file in the user template directory will also be removed.

-

Parameters

+

Parameters

@@ -1076,21 +1052,20 @@ directory will also be removed.

-

Returns

+

Returns

Status of registration attempt (lglDbDeleteStatus)

-

lgl_db_delete_template_by_name ()

lglDbDeleteStatus
-lgl_db_delete_template_by_name (const gchar *name);
+lgl_db_delete_template_by_name (const gchar *name);

Delete a user defined template. This function deletes a template from the template database. The individual XML file in the user template directory will also be removed.

-

Parameters

+

Parameters

@@ -1105,20 +1080,19 @@ directory will also be removed.

-

Returns

+

Returns

Status of registration attempt (lglDbDeleteStatus)

-

lgl_db_does_template_exist ()

-
gboolean
-lgl_db_does_template_exist (const gchar *brand,
-                            const gchar *part);
+
gboolean
+lgl_db_does_template_exist (const gchar *brand,
+                            const gchar *part);

This function tests whether a template with the given brand and part name/number exists.

-

Parameters

+

Parameters

@@ -1140,19 +1114,18 @@ lgl_db_does_template_exist (const -

Returns

+

Returns

TRUE if such a template exists in the database.

-

lgl_db_does_template_name_exist ()

-
gboolean
-lgl_db_does_template_name_exist (const gchar *name);
+
gboolean
+lgl_db_does_template_name_exist (const gchar *name);

This function test whether a template with the given name exists.

-

Parameters

+

Parameters

@@ -1167,24 +1140,23 @@ lgl_db_does_template_name_exist (const -

Returns

+

Returns

TRUE if such a template exists in the database.

-

lgl_db_get_template_name_list_all ()

-
GList *
-lgl_db_get_template_name_list_all (const gchar *brand,
-                                   const gchar *paper_id,
-                                   const gchar *category_id);
+
GList *
+lgl_db_get_template_name_list_all (const gchar *brand,
+                                   const gchar *paper_id,
+                                   const gchar *category_id);

Get a list of all valid names of templates in the template database. Results can be filtered by page size and/or template category. A list of valid page sizes can be obtained using lgl_db_get_paper_id_list(). A list of valid template categories can be obtained using lgl_db_get_category_id_list().

-

Parameters

+

Parameters

@@ -1211,20 +1183,19 @@ categories can be obtained using -

Returns

+

Returns

a list of template names.

-

lgl_db_get_similar_template_name_list ()

-
GList *
-lgl_db_get_similar_template_name_list (const gchar *name);
+
GList *
+lgl_db_get_similar_template_name_list (const gchar *name);

Get a list of all valid names of templates in the template database that have the same size and layout characteristics as the given template.

-

Parameters

+

Parameters

@@ -1239,20 +1210,19 @@ have the same size and layout characteristics as the given template.

-

Returns

+

Returns

a list of template names.

-

lgl_db_free_template_name_list ()

void
-lgl_db_free_template_name_list (GList *names);
+lgl_db_free_template_name_list (GList *names);

Free up all storage associated with a list of template names obtained with lgl_db_get_template_name_list_all().

-

Parameters

+

Parameters

@@ -1271,10 +1241,10 @@ lgl_db_free_template_name_list (

lgl_db_lookup_template_from_name ()

lglTemplate *
-lgl_db_lookup_template_from_name (const gchar *name);
+lgl_db_lookup_template_from_name (const gchar *name);

Lookup template in template database from name string.

-

Parameters

+

Parameters

@@ -1289,9 +1259,8 @@ lgl_db_lookup_template_from_name (const -

Returns

+

Returns

pointer to a newly allocated lglTemplate structure.

-

@@ -1299,11 +1268,11 @@ lgl_db_lookup_template_from_name (const

lgl_db_lookup_template_from_brand_part ()

lglTemplate *
 lgl_db_lookup_template_from_brand_part
-                               (const gchar *brand,
-                                const gchar *part);
+ (const gchar *brand, + const gchar *part);

Lookup template in template database from brand and part strings.

-

Parameters

+

Parameters

@@ -1325,32 +1294,30 @@ lgl_db_lookup_template_from_brand_part
-

Returns

+

Returns

pointer to a newly allocated lglTemplate structure.

-

lgl_db_get_vendor_name_list ()

-
GList *
+
GList *
 lgl_db_get_vendor_name_list (void);

 
Get a list of all localized vendor names known to libglabels.

 

-
Returns

+
Returns

 
 a list of localized vendor names.

-

lgl_db_free_vendor_name_list ()

void
-lgl_db_free_vendor_name_list (GList *names);
+lgl_db_free_vendor_name_list (GList *names);

Free up all storage associated with a name list obtained with lgl_db_get_vendor_name_list().

-

Parameters

+

Parameters

@@ -1368,11 +1335,11 @@ lgl_db_free_vendor_name_list (

lgl_db_is_vendor_name_known ()

-
gboolean
-lgl_db_is_vendor_name_known (const gchar *name);
+
gboolean
+lgl_db_is_vendor_name_known (const gchar *name);

Determine if given vendor id is known to libglabels.

-

Parameters

+

Parameters

@@ -1387,19 +1354,18 @@ lgl_db_is_vendor_name_known (const -

Returns

+

Returns

TRUE if id is known, otherwise FALSE.

-

lgl_db_lookup_vendor_from_name ()

lglVendor *
-lgl_db_lookup_vendor_from_name (const gchar *name);
+lgl_db_lookup_vendor_from_name (const gchar *name);

Lookup vendor definition from localized vendor name string.

-

Parameters

+

Parameters

@@ -1414,9 +1380,8 @@ lgl_db_lookup_vendor_from_name (const -

Returns

+

Returns

pointer to a newly allocated lglVendor structure.

-

@@ -1459,7 +1424,7 @@ libglabels.

This enumeration defines a set of possible return values for lgl_db_register_template().

-

Members

+

Members

@@ -1506,7 +1471,7 @@ This enumeration defines a set of possible return values for lgl_db_delete_template_by_name() or lgl_db_delete_template_by_brand_part().

-

Members

+

Members

@@ -1549,7 +1514,6 @@ This enumeration defines a set of possible return values for
-
- Generated by GTK-Doc V1.20
+
Generated by GTK-Doc V1.24 \ No newline at end of file