X-Git-Url: https://git.sur5r.net/?p=glabels;a=blobdiff_plain;f=docs%2Flibglbarcode%2Fhtml%2Flibglbarcode-3.0-lgl-barcode.html;h=074f1ae46c3744fd4b62da26656300c3c138b2d5;hp=97ce1bd4350c2d3d58682553df21fae40c3c8811;hb=8e4c50283c4f353b18c68474f91209b8bd050557;hpb=bf6d7db22a79d11630454dcd2e867764e89ca9fe diff --git a/docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode.html b/docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode.html index 97ce1bd4..074f1ae4 100644 --- a/docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode.html +++ b/docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode.html @@ -2,30 +2,27 @@ -lglBarcode - +LibGlbarcode 3.0 Reference Manual: lglBarcode + - + - - - - - - - - - - + + + + + + +
@@ -33,58 +30,142 @@

lglBarcode

lglBarcode — Barcode structure

- +
-
-

Synopsis

-
-#include <libglbarcode/lgl-barcode.h>
-
-                    lglBarcode;
-
-lglBarcode *        lgl_barcode_new                     (void);
-void                lgl_barcode_free                    (lglBarcode *bc);
-
-enum                lglBarcodeShapeType;
-                    lglBarcodeShape;
-                    lglBarcodeShapeAny;
-                    lglBarcodeShapeLine;
-                    lglBarcodeShapeBox;
-                    lglBarcodeShapeChar;
-                    lglBarcodeShapeString;
-                    lglBarcodeShapeRing;
-                    lglBarcodeShapeHexagon;
-
-void                lgl_barcode_add_line                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble length,
-                                                         gdouble width);
-void                lgl_barcode_add_box                 (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble width,
-                                                         gdouble height);
-void                lgl_barcode_add_char                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble fsize,
-                                                         gchar c);
-void                lgl_barcode_add_string              (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble fsize,
-                                                         gchar *string,
-                                                         gsize length);
-void                lgl_barcode_add_ring                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble radius,
-                                                         gdouble line_width);
-void                lgl_barcode_add_hexagon             (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble height);
+

+
Functions

+

++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





+lglBarcode *
+
+lgl_barcode_new ()
+

+void
+
+lgl_barcode_free ()
+

+void
+
+lgl_barcode_add_line ()
+

+void
+
+lgl_barcode_add_box ()
+

+void
+
+lgl_barcode_add_char ()
+

+void
+
+lgl_barcode_add_string ()
+

+void
+
+lgl_barcode_add_ring ()
+

+void
+
+lgl_barcode_add_hexagon ()
+

+

+

+
Types and Values

+

++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+




 lglBarcode
enumlglBarcodeShapeType
 lglBarcodeShape
 lglBarcodeShapeAny
 lglBarcodeShapeLine
 lglBarcodeShapeBox
 lglBarcodeShapeChar
 lglBarcodeShapeString
 lglBarcodeShapeRing
 lglBarcodeShapeHexagon

+

+

+
Object Hierarchy

+
+

+

+

+
Includes

+
#include <libglbarcode/lgl-barcode.h>
 

 

 

@@ -96,7 +177,362 @@ The section also defines a set of functions for constructing an 
 

 

-
Details

+
Functions

+

+
lgl_barcode_new ()

+
lglBarcode *
+lgl_barcode_new (void);

+
Allocate a new lglBarcode structure.

+
This function allocates a new lglBarcode structure.

+

+      This function is intended to be used internally by barcode implementations.
+      Typically an end-user would use lgl_barcode_create() instead.
+

+

+
Returns

+
 A newly allocated lglBarcode structure.  Use lgl_barcode_free() to
+free it.

+

+

+

+

+

+
lgl_barcode_free ()

+
void
+lgl_barcode_free (lglBarcode *bc);

+
Free a previously allocated lglBarcode structure.

+

+
Parameters

+

+++++
+
+
+
+
+
+





bc
The lglBarcode structure to free
 

+

+

+

+

+
lgl_barcode_add_line ()

+
void
+lgl_barcode_add_line (lglBarcode *bc,
+                      gdouble x,
+                      gdouble y,
+                      gdouble length,
+                      gdouble width);

+
Add a vertical line to barcode.  Coordinates are relative to top left corner
+of barcode.  All units are in points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of top of line
 
y
y coordinate of top of line
 
length
Length of line
 
width
Width of line
 

+

+

+

+

+
lgl_barcode_add_box ()

+
void
+lgl_barcode_add_box (lglBarcode *bc,
+                     gdouble x,
+                     gdouble y,
+                     gdouble width,
+                     gdouble height);

+
Add a box to barcode.  Coordinates are relative to top left corner
+of barcode.  All units are in points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of top left corner of box
 
y
y coordinate of top left corner of box
 
width
Width of box
 
height
Height of box
 

+

+

+

+

+
lgl_barcode_add_char ()

+
void
+lgl_barcode_add_char (lglBarcode *bc,
+                      gdouble x,
+                      gdouble y,
+                      gdouble fsize,
+                      gchar c);

+
Add an ASCII character to barcode.  Coordinates are relative to top left corner
+of barcode.  All units are in points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of left baseline of character
 
y
y coordinate of left baseline of character
 
fsize
Font size
 
c
Character to add
 

+

+

+

+

+
lgl_barcode_add_string ()

+
void
+lgl_barcode_add_string (lglBarcode *bc,
+                        gdouble x,
+                        gdouble y,
+                        gdouble fsize,
+                        gchar *string,
+                        gsize length);

+
Add a character string to barcode.  Coordinates are relative to top left corner
+of barcode.  All units are in points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of horizontal center of baseline of string
 
y
y coordinate of horizontal center of baseline of string
 
fsize
Font size
 
string
String to add
 
length
Number of bytes in string
 

+

+

+

+

+
lgl_barcode_add_ring ()

+
void
+lgl_barcode_add_ring (lglBarcode *bc,
+                      gdouble x,
+                      gdouble y,
+                      gdouble radius,
+                      gdouble line_width);

+
Add a ring to barcode.  Coordinates are relative to top left corner
+of barcode.  All units are in points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of center of circle
 
y
y coordinate of center of circle
 
radius
Radius of ring (center of line)
 
line_width
Width of line
 

+

+

+

+

+
lgl_barcode_add_hexagon ()

+
void
+lgl_barcode_add_hexagon (lglBarcode *bc,
+                         gdouble x,
+                         gdouble y,
+                         gdouble height);

+
Add a regular hexagon (oriented with vertexes at top and bottom) to barcode.
+Coordinates are relative to top left corner of barcode.  All units are in
+points ( 1 point = 1/72 inch ).

+

+       This function is intended to be used internally by barcode implementations.
+

+

+
Parameters

+

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





bc
An lglBarcode structure
 
x
x coordinate of top point of hexagon
 
y
y coordinate of top point of hexagon
 
height
Height of hexagon
 

+

+

+

+

+
Types and Values

 

 
lglBarcode

 
typedef struct {
@@ -106,108 +542,90 @@ The section also defines a set of functions for constructing an 
-

-This structure contains the libglbarcode intermediate barcode format.  This
+
This structure contains the libglbarcode intermediate barcode format.  This
 structure contains a simple vectorized representation of the barcode.  This
 vectorized representation is easy to interpret by a rendering backend for
 either vector or raster formats.  A simple API is provided for constructing
-barcodes in this format.
-

-

-+barcodes in this format.

+

+
Members

+



+++++
-
-
+
+
+
-
-
+
+
+
-
-
+
+
+





 
 
gdouble width;
Width of barcode bounding box (points)
gdouble width;
Width of barcode bounding box (points)
 
 

 
gdouble height;
Height of barcode bounding box (points)
gdouble height;
Height of barcode bounding box (points)
 
 

 
GList *shapes;
List of lglBarcodeShape drawing primitives
GList *shapes;
List of lglBarcodeShape drawing primitives
 
 

 
 

 

-

-

-
lgl_barcode_new ()

-
lglBarcode *        lgl_barcode_new                     (void);

-

-Allocate a new lglBarcode structure.
-

-

-This function allocates a new lglBarcode structure.
-

-

-

-

-
Note

-

-      This function is intended to be used internally by barcode implementations.
-      Typically an end-user would use lgl_barcode_create() instead.
-

-

-

-

-

--
-
-
-
-


Returns :
A newly allocated lglBarcode structure.  Use lgl_barcode_free() to
-free it.

 

 

 

-
lgl_barcode_free ()

-
void                lgl_barcode_free                    (lglBarcode *bc);

+
enum lglBarcodeShapeType

 

-Free a previously allocated lglBarcode structure.
 

-

--
-
-
-
+

+
Members

+


bc :
The lglBarcode structure to free

+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+





LGL_BARCODE_SHAPE_LINE
  
LGL_BARCODE_SHAPE_BOX
  
LGL_BARCODE_SHAPE_CHAR
  
LGL_BARCODE_SHAPE_STRING
  
LGL_BARCODE_SHAPE_RING
  
LGL_BARCODE_SHAPE_HEXAGON
  

 

 

-

-

-
enum lglBarcodeShapeType

-
typedef enum {
-        LGL_BARCODE_SHAPE_LINE,
-        LGL_BARCODE_SHAPE_BOX,
-        LGL_BARCODE_SHAPE_CHAR,
-        LGL_BARCODE_SHAPE_STRING,
-        LGL_BARCODE_SHAPE_RING,
-        LGL_BARCODE_SHAPE_HEXAGON
-} lglBarcodeShapeType;
-

-

-

 

 

 

 
lglBarcodeShape

-
typedef union {
-
-        lglBarcodeShapeType    type;
-        lglBarcodeShapeAny     any;
-
-        lglBarcodeShapeLine    line;
-        lglBarcodeShapeBox     box;
-        lglBarcodeShapeChar    bchar;
-        lglBarcodeShapeString  string;
-        lglBarcodeShapeRing    ring;
-        lglBarcodeShapeHexagon hexagon;
-
-} lglBarcodeShape;
-

 

 

 

@@ -239,11 +657,7 @@ Free a previously allocated 
 
 @ =  origin (x,y) from top left corner of barcode
@@ -260,38 +674,45 @@ A vertical line drawing primitive.
               width
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_LINE -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_LINE

 

gdouble x;

x coordinate of top of line

gdouble x;

x coordinate of top of line

 

gdouble y;

y coordinate of top of line

gdouble y;

y coordinate of top of line

 

gdouble length;

Length of line

gdouble length;

Length of line

 

gdouble width;

Width of line

gdouble width;

Width of line

 
+

lglBarcodeShapeBox

@@ -306,11 +727,7 @@ All units are in points ( 1 point = 1/72 inch ). gdouble height; } lglBarcodeShapeBox; -

-A solid box drawing primitive. -

-

-

+

A solid box drawing primitive.

 
 @ =  origin (x,y) from top left corner of barcode
@@ -327,38 +744,45 @@ A solid box drawing primitive.
                 width
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_BOX -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_BOX

 

gdouble x;

x coordinate of top left corner of box

gdouble x;

x coordinate of top left corner of box

 

gdouble y;

y coordinate of top left corner of box

gdouble y;

y coordinate of top left corner of box

 

gdouble width;

Width of box

gdouble width;

Width of box

 

gdouble height;

Height of box

gdouble height;

Height of box

 
+

lglBarcodeShapeChar

@@ -373,11 +797,7 @@ All units are in points ( 1 point = 1/72 inch ). gchar c; } lglBarcodeShapeChar; -

-An single byte character drawing primitive. -

-

-

+

An single byte character drawing primitive.

 
 @ =  origin (x,y) from top left corner of barcode
@@ -393,38 +813,45 @@ An single byte character drawing primitive.
       @ ----------------------
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_CHAR -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_CHAR

 

gdouble x;

x coordinate of left baseline of character

gdouble x;

x coordinate of left baseline of character

 

gdouble y;

y coordinate of left baseline of character

gdouble y;

y coordinate of left baseline of character

 

gdouble fsize;

Font size

gdouble fsize;

Font size

 

gchar c;

Character to add

gchar c;

Character to add

 
+

lglBarcodeShapeString

@@ -439,11 +866,7 @@ All units are in points ( 1 point = 1/72 inch ). gchar *string; } lglBarcodeShapeString; -

-A character string drawing primitive. -

-

-

+

A character string drawing primitive.

 
 @ =  origin (x,y) from top left corner of barcode
@@ -460,38 +883,45 @@ A character string drawing primitive.
                           x = horizontal center
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_STRING -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_STRING

 

gdouble x;

x coordinate of horizontal center of baseline of string

gdouble x;

x coordinate of horizontal center of baseline of string

 

gdouble y;

y coordinate of horizontal center of baseline of string

gdouble y;

y coordinate of horizontal center of baseline of string

 

gdouble fsize;

Font size

gdouble fsize;

Font size

 

gchar *string;

String to add

gchar *string;

String to add

 
+

lglBarcodeShapeRing

@@ -506,11 +936,7 @@ All units are in points ( 1 point = 1/72 inch ). gdouble line_width; } lglBarcodeShapeRing; -

-A ring (an open circle) drawing primitive. -

-

-

+

A ring (an open circle) drawing primitive.

 
 @ = origin (x,y) is centre of circle
@@ -527,38 +953,45 @@ A ring (an open circle) drawing primitive.
            `-....-'
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_RING -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_RING

 

gdouble x;

x coordinate of center of circle

gdouble x;

x coordinate of center of circle

 

gdouble y;

y coordinate of center of circle

gdouble y;

y coordinate of center of circle

 

gdouble radius;

Radius of ring (center of line)

gdouble radius;

Radius of ring (center of line)

 

gdouble line_width;

Width of line

gdouble line_width;

Width of line

 
+

lglBarcodeShapeHexagon

@@ -572,11 +1005,7 @@ All units are in points ( 1 point = 1/72 inch ). gdouble height; } lglBarcodeShapeHexagon; -

-A solid regular hexagon (oriented with vertexes at top and bottom) drawing primitive. -

-

-

+

A solid regular hexagon (oriented with vertexes at top and bottom) drawing primitive.

 
 @ = origin (x,y) is top of hexagon
@@ -597,327 +1026,44 @@ A solid regular hexagon (oriented with vertexes at top and bottom) drawing primi
                  " ------------------
-

-

-

-All units are in points ( 1 point = 1/72 inch ). -

-
-+

All units are in points ( 1 point = 1/72 inch ).

+
+

Members

+
+++++ - - + + + - - + + + - - + + + - - + + +

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_HEXAGON -

lglBarcodeShapeType type;

Always LGL_BARCODE_SHAPE_HEXAGON

 

gdouble x;

x coordinate of top point of hexagon

gdouble x;

x coordinate of top point of hexagon

 

gdouble y;

y coordinate of top point of hexagon

gdouble y;

y coordinate of top point of hexagon

 

gdouble height;

Height of hexagon

gdouble height;

Height of hexagon

 
-
-
-

lgl_barcode_add_line ()

-
void                lgl_barcode_add_line                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble length,
-                                                         gdouble width);
-

-Add a vertical line to barcode. Coordinates are relative to top left corner -of barcode. All units are in points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of top of line

y :

y coordinate of top of line

length :

Length of line

width :

Width of line
-
-
-
-

lgl_barcode_add_box ()

-
void                lgl_barcode_add_box                 (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble width,
-                                                         gdouble height);
-

-Add a box to barcode. Coordinates are relative to top left corner -of barcode. All units are in points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of top left corner of box

y :

y coordinate of top left corner of box

width :

Width of box

height :

Height of box
-
-
-
-

lgl_barcode_add_char ()

-
void                lgl_barcode_add_char                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble fsize,
-                                                         gchar c);
-

-Add an ASCII character to barcode. Coordinates are relative to top left corner -of barcode. All units are in points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of left baseline of character

y :

y coordinate of left baseline of character

fsize :

Font size

c :

Character to add
-
-
-
-

lgl_barcode_add_string ()

-
void                lgl_barcode_add_string              (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble fsize,
-                                                         gchar *string,
-                                                         gsize length);
-

-Add a character string to barcode. Coordinates are relative to top left corner -of barcode. All units are in points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of horizontal center of baseline of string

y :

y coordinate of horizontal center of baseline of string

fsize :

Font size

string :

String to add

length :

Number of bytes in string
-
-
-
-

lgl_barcode_add_ring ()

-
void                lgl_barcode_add_ring                (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble radius,
-                                                         gdouble line_width);
-

-Add a ring to barcode. Coordinates are relative to top left corner -of barcode. All units are in points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of center of circle

y :

y coordinate of center of circle

radius :

Radius of ring (center of line)

line_width :

Width of line
-
-
-
-

lgl_barcode_add_hexagon ()

-
void                lgl_barcode_add_hexagon             (lglBarcode *bc,
-                                                         gdouble x,
-                                                         gdouble y,
-                                                         gdouble height);
-

-Add a regular hexagon (oriented with vertexes at top and bottom) to barcode. -Coordinates are relative to top left corner of barcode. All units are in -points ( 1 point = 1/72 inch ). -

-

-

-
-

Note

-

- This function is intended to be used internally by barcode implementations. -

-
-

-

-
-- - - - - - - - - - - - - - - - - - -

bc :

An lglBarcode structure

x :

x coordinate of top point of hexagon

y :

y coordinate of top point of hexagon

height :

Height of hexagon
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.20 \ No newline at end of file