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: LibGlbarcode 3.0 Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.24 (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="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#libglbarcode-3.0-lgl-barcode-create.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="libglbarcode-3.0-lgl-barcode.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libglbarcode-3.0-lgl-barcode-render-to-cairo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="libglbarcode-3.0-lgl-barcode-create"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libglbarcode-3.0-lgl-barcode-create.top_of_page"></a>Barcode Factory</span></h2>
  30 <p>Barcode Factory — Basic end-user barcode creation API</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libglbarcode-3.0-lgl-barcode-create.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody><tr>
  42 <td class="function_type">
  43 <a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="returnvalue">lglBarcode</span></a> *
  44 </td>
  45 <td class="function_name">
  46 <a class="link" href="libglbarcode-3.0-lgl-barcode-create.html#lgl-barcode-create" title="lgl_barcode_create ()">lgl_barcode_create</a> <span class="c_punctuation">()</span>
  47 </td>
  48 </tr></tbody>
  49 </table></div>
  50 </div>
  51 <div class="refsect1">
  52 <a name="libglbarcode-3.0-lgl-barcode-create.includes"></a><h2>Includes</h2>
  53 <pre class="synopsis">#include &lt;libglbarcode/lgl-barcode-create.h&gt;
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="libglbarcode-3.0-lgl-barcode-create.description"></a><h2>Description</h2>
  58 <p>
  59 This section describes a simple API to select and create <span class="type">glBarcode</span> structures using a built-in
  60 barcode backend.
  61 </p>
  62 </div>
  63 <div class="refsect1">
  64 <a name="libglbarcode-3.0-lgl-barcode-create.functions_details"></a><h2>Functions</h2>
  65 <div class="refsect2">
  66 <a name="lgl-barcode-create"></a><h3>lgl_barcode_create ()</h3>
  67 <pre class="programlisting"><a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="returnvalue">lglBarcode</span></a> *
  68 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>,
  69                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> text_flag</code></em>,
  70                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> checksum_flag</code></em>,
  71                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> w</code></em>,
  72                     <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> h</code></em>,
  73                     <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>);</pre>
  74 <p>Create a new barcode structure, encoding <em class="parameter"><code>data</code></em>
  75  with selected barcode type and
  76 characteristics.</p>
  77 <p>Barcode dimensions (<em class="parameter"><code>w</code></em>
  78  and <em class="parameter"><code>h</code></em>
  79 ) are in points ( 1 point = 1/72 inch ).
  80 If either <em class="parameter"><code>w</code></em>
  81  or <em class="parameter"><code>h</code></em>
  82  are zero, the barcode will be rendered in a nominal size
  83 appropriate for the barcode type and data.  The actual size of the resulting
  84 barcode may also be limited by required tolerances of line sizes and spacing
  85 for the given barcode type.</p>
  86 <div class="refsect3">
  87 <a name="id-1.3.3.6.2.6"></a><h4>Parameters</h4>
  88 <div class="informaltable"><table width="100%" border="0">
  89 <colgroup>
  90 <col width="150px" class="parameters_name">
  91 <col class="parameters_description">
  92 <col width="200px" class="parameters_annotations">
  93 </colgroup>
  94 <tbody>
  95 <tr>
  96 <td class="parameter_name"><p>type</p></td>
  97 <td class="parameter_description"><p>Barcode type selection (<a class="link" href="libglbarcode-3.0-lgl-barcode-type.html#lglBarcodeType" title="enum lglBarcodeType"><span class="type">lglBarcodeType</span></a>)</p></td>
  98 <td class="parameter_annotations"> </td>
  99 </tr>
 100 <tr>
 101 <td class="parameter_name"><p>text_flag</p></td>
 102 <td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show text, if supported by barcode type</p></td>
 103 <td class="parameter_annotations"> </td>
 104 </tr>
 105 <tr>
 106 <td class="parameter_name"><p>checksum_flag</p></td>
 107 <td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to include checksum, if supported or optional for barcode type</p></td>
 108 <td class="parameter_annotations"> </td>
 109 </tr>
 110 <tr>
 111 <td class="parameter_name"><p>w</p></td>
 112 <td class="parameter_description"><p>Suggested width of barcode</p></td>
 113 <td class="parameter_annotations"> </td>
 114 </tr>
 115 <tr>
 116 <td class="parameter_name"><p>h</p></td>
 117 <td class="parameter_description"><p>Suggested height of barcode</p></td>
 118 <td class="parameter_annotations"> </td>
 119 </tr>
 120 <tr>
 121 <td class="parameter_name"><p>data</p></td>
 122 <td class="parameter_description"><p>Data to encode into barcode</p></td>
 123 <td class="parameter_annotations"> </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <div class="refsect3">
 129 <a name="id-1.3.3.6.2.7"></a><h4>Returns</h4>
 130 <p> 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
 131 free it.</p>
 132 </div>
 133 </div>
 134 </div>
 135 <div class="refsect1">
 136 <a name="libglbarcode-3.0-lgl-barcode-create.other_details"></a><h2>Types and Values</h2>
 137 </div>
 138 </div>
 139 <div class="footer">
 140 <hr>Generated by GTK-Doc V1.24</div>
 141 </body>
 142 </html>