git.sur5r.net Git - glabels/blob - docs/libglbarcode/tmpl/lgl-barcode.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 lglBarcode
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Barcode structure
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 This section describes the #lglBarcode structure and the #lglBarcodeShape family of simple drawing primitives.
  10 These structures form the basic intermediate barcode representation used by libglbarcode.
  11 The section also defines a set of functions for constructing an #lglBarcode structure and populating it with drawing primitives.
  12 </para>
  13
  14 <!-- ##### SECTION See_Also ##### -->
  15 <para>
  16
  17 </para>
  18
  19 <!-- ##### SECTION Stability_Level ##### -->
  20
  21
  22 <!-- ##### SECTION Image ##### -->
  23
  24
  25 <!-- ##### STRUCT lglBarcode ##### -->
  26 <para>
  27
  28 </para>
  29
  30 @width:
  31 @height:
  32 @shapes:
  33
  34 <!-- ##### FUNCTION lgl_barcode_new ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @void:
  40 @Returns:
  41
  42
  43 <!-- ##### FUNCTION lgl_barcode_free ##### -->
  44 <para>
  45
  46 </para>
  47
  48 @bc:
  49
  50
  51 <!-- ##### ENUM lglBarcodeShapeType ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @LGL_BARCODE_SHAPE_LINE:
  57 @LGL_BARCODE_SHAPE_BOX:
  58 @LGL_BARCODE_SHAPE_CHAR:
  59 @LGL_BARCODE_SHAPE_STRING:
  60 @LGL_BARCODE_SHAPE_RING:
  61 @LGL_BARCODE_SHAPE_HEXAGON:
  62
  63 <!-- ##### UNION lglBarcodeShape ##### -->
  64 <para>
  65
  66 </para>
  67
  68
  69 <!-- ##### STRUCT lglBarcodeShapeAny ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @type:
  75 @x:
  76 @y:
  77
  78 <!-- ##### STRUCT lglBarcodeShapeLine ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @type:
  84 @x:
  85 @y:
  86 @length:
  87 @width:
  88
  89 <!-- ##### STRUCT lglBarcodeShapeBox ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @type:
  95 @x:
  96 @y:
  97 @width:
  98 @height:
  99
 100 <!-- ##### STRUCT lglBarcodeShapeChar ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @type:
 106 @x:
 107 @y:
 108 @fsize:
 109 @c:
 110
 111 <!-- ##### STRUCT lglBarcodeShapeString ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @type:
 117 @x:
 118 @y:
 119 @fsize:
 120 @string:
 121
 122 <!-- ##### STRUCT lglBarcodeShapeRing ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @type:
 128 @x:
 129 @y:
 130 @radius:
 131 @line_width:
 132
 133 <!-- ##### STRUCT lglBarcodeShapeHexagon ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @type:
 139 @x:
 140 @y:
 141 @height:
 142
 143 <!-- ##### FUNCTION lgl_barcode_add_line ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @bc:
 149 @x:
 150 @y:
 151 @length:
 152 @width:
 153
 154
 155 <!-- ##### FUNCTION lgl_barcode_add_box ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @bc:
 161 @x:
 162 @y:
 163 @width:
 164 @height:
 165
 166
 167 <!-- ##### FUNCTION lgl_barcode_add_char ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @bc:
 173 @x:
 174 @y:
 175 @fsize:
 176 @c:
 177
 178
 179 <!-- ##### FUNCTION lgl_barcode_add_string ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @bc:
 185 @x:
 186 @y:
 187 @fsize:
 188 @string:
 189 @length:
 190
 191
 192 <!-- ##### FUNCTION lgl_barcode_add_ring ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @bc:
 198 @x:
 199 @y:
 200 @radius:
 201 @line_width:
 202
 203
 204 <!-- ##### FUNCTION lgl_barcode_add_hexagon ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @bc:
 210 @x:
 211 @y:
 212 @height:
 213
 214