git.sur5r.net Git - glabels/blob - docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode-create.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Barcode Factory</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="LibGlbarcode 3.0 Reference Manual">
   8 <link rel="up" href="api.html" title="API Reference">
   9 <link rel="prev" href="libglbarcode-3.0-lgl-barcode.html" title="lglBarcode">
  10 <link rel="next" href="libglbarcode-3.0-lgl-barcode-render-to-cairo.html" title="Cairo Renderer">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libglbarcode-3.0-lgl-barcode.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">LibGlbarcode 3.0 Reference Manual</th>
  21 <td><a accesskey="n" href="libglbarcode-3.0-lgl-barcode-render-to-cairo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libglbarcode-3.0-lgl-barcode-create.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglbarcode-3.0-lgl-barcode-create.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglbarcode-3.0-lgl-barcode-create"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libglbarcode-3.0-lgl-barcode-create.top_of_page"></a>Barcode Factory</span></h2>
  34 <p>Barcode Factory — Basic end-user barcode creation API</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglbarcode-3.0-lgl-barcode-create.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglbarcode/lgl-barcode-create.h&gt;
  42
  43 <a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="returnvalue">lglBarcode</span></a> *        <a class="link" href="libglbarcode-3.0-lgl-barcode-create.html#lgl-barcode-create" title="lgl_barcode_create ()">lgl_barcode_create</a>                  (<em class="parameter"><code><a class="link" href="libglbarcode-3.0-lgl-barcode-type.html#lglBarcodeType" title="enum lglBarcodeType"><span class="type">lglBarcodeType</span></a> type</code></em>,
  44                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> text_flag</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> checksum_flag</code></em>,
  46                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> w</code></em>,
  47                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> h</code></em>,
  48                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>);
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="libglbarcode-3.0-lgl-barcode-create.description"></a><h2>Description</h2>
  53 <p>
  54 This section describes a simple API to select and create <span class="type">glBarcode</span> structures using a built-in
  55 barcode backend.
  56 </p>
  57 </div>
  58 <div class="refsect1">
  59 <a name="libglbarcode-3.0-lgl-barcode-create.details"></a><h2>Details</h2>
  60 <div class="refsect2">
  61 <a name="lgl-barcode-create"></a><h3>lgl_barcode_create ()</h3>
  62 <pre class="programlisting"><a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="returnvalue">lglBarcode</span></a> *        lgl_barcode_create                  (<em class="parameter"><code><a class="link" href="libglbarcode-3.0-lgl-barcode-type.html#lglBarcodeType" title="enum lglBarcodeType"><span class="type">lglBarcodeType</span></a> type</code></em>,
  63                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> text_flag</code></em>,
  64                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> checksum_flag</code></em>,
  65                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> w</code></em>,
  66                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> h</code></em>,
  67                                                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>);</pre>
  68 <p>
  69 Create a new barcode structure, encoding <em class="parameter"><code>data</code></em> with selected barcode type and
  70 characteristics.
  71 </p>
  72 <p>
  73 Barcode dimensions (<em class="parameter"><code>w</code></em> and <em class="parameter"><code>h</code></em>) are in points ( 1 point = 1/72 inch ).
  74 If either <em class="parameter"><code>w</code></em> or <em class="parameter"><code>h</code></em> are zero, the barcode will be rendered in a nominal size
  75 appropriate for the barcode type and data.  The actual size of the resulting
  76 barcode may also be limited by required tolerances of line sizes and spacing
  77 for the given barcode type.
  78 </p>
  79 <div class="variablelist"><table border="0">
  80 <col align="left" valign="top">
  81 <tbody>
  82 <tr>
  83 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
  84 <td>Barcode type selection (<a class="link" href="libglbarcode-3.0-lgl-barcode-type.html#lglBarcodeType" title="enum lglBarcodeType"><span class="type">lglBarcodeType</span></a>)</td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><em class="parameter"><code>text_flag</code></em> :</span></p></td>
  88 <td>
  89 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show text, if supported by barcode type</td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><em class="parameter"><code>checksum_flag</code></em> :</span></p></td>
  93 <td>
  94 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to include checksum, if supported or optional for barcode type</td>
  95 </tr>
  96 <tr>
  97 <td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
  98 <td>Suggested width of barcode</td>
  99 </tr>
 100 <tr>
 101 <td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
 102 <td>Suggested height of barcode</td>
 103 </tr>
 104 <tr>
 105 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 106 <td>Data to encode into barcode</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 110 <td>A newly allocated <a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="type">lglBarcode</span></a> structure.  Use <a class="link" href="libglbarcode-3.0-lgl-barcode.html#lgl-barcode-free" title="lgl_barcode_free ()"><code class="function">lgl_barcode_free()</code></a> to
 111 free it.</td>
 112 </tr>
 113 </tbody>
 114 </table></div>
 115 </div>
 116 </div>
 117 </div>
 118 <div class="footer">
 119 <hr>
 120           Generated by GTK-Doc V1.17</div>
 121 </body>
 122 </html>