]> git.sur5r.net Git - glabels/blobdiff - docs/libglbarcode/html/libglbarcode-3.0-lgl-barcode-create.html
Imported Upstream version 3.2.1
[glabels] / docs / libglbarcode / html / libglbarcode-3.0-lgl-barcode-create.html
index a1d39f131fa88c768fd1c6eb6446c15d516b66e9..510369c0a63c093bb02e682ef78cbd4b9ffe904a 100644 (file)
@@ -2,30 +2,27 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Barcode Factory</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<title>LibGlbarcode 3.0 Reference Manual: Barcode Factory</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="LibGlbarcode 3.0 Reference Manual">
 <link rel="up" href="api.html" title="API Reference">
 <link rel="prev" href="libglbarcode-3.0-lgl-barcode.html" title="lglBarcode">
 <link rel="next" href="libglbarcode-3.0-lgl-barcode-render-to-cairo.html" title="Cairo Renderer">
 <link rel="home" href="index.html" title="LibGlbarcode 3.0 Reference Manual">
 <link rel="up" href="api.html" title="API Reference">
 <link rel="prev" href="libglbarcode-3.0-lgl-barcode.html" title="lglBarcode">
 <link rel="next" href="libglbarcode-3.0-lgl-barcode-render-to-cairo.html" title="Cairo Renderer">
-<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
-<tr valign="middle">
-<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>
-<td><a accesskey="u" href="api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
-<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
-<th width="100%" align="center">LibGlbarcode 3.0 Reference Manual</th>
-<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>
-</tr>
-<tr><td colspan="5" class="shortcuts">
-<a href="#libglbarcode-3.0-lgl-barcode-create.synopsis" class="shortcut">Top</a>
-                   | 
-                  <a href="#libglbarcode-3.0-lgl-barcode-create.description" class="shortcut">Description</a>
-</td></tr>
-</table>
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
+                  <a href="#libglbarcode-3.0-lgl-barcode-create.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
+                  <a href="#libglbarcode-3.0-lgl-barcode-create.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<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>
+<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>
+</tr></table>
 <div class="refentry">
 <a name="libglbarcode-3.0-lgl-barcode-create"></a><div class="titlepage"></div>
 <div class="refnamediv"><table width="100%"><tr>
 <div class="refentry">
 <a name="libglbarcode-3.0-lgl-barcode-create"></a><div class="titlepage"></div>
 <div class="refnamediv"><table width="100%"><tr>
 <h2><span class="refentrytitle"><a name="libglbarcode-3.0-lgl-barcode-create.top_of_page"></a>Barcode Factory</span></h2>
 <p>Barcode Factory — Basic end-user barcode creation API</p>
 </td>
 <h2><span class="refentrytitle"><a name="libglbarcode-3.0-lgl-barcode-create.top_of_page"></a>Barcode Factory</span></h2>
 <p>Barcode Factory — Basic end-user barcode creation API</p>
 </td>
-<td valign="top" align="right"></td>
+<td class="gallery_image" valign="top" align="right"></td>
 </tr></table></div>
 </tr></table></div>
-<div class="refsynopsisdiv">
-<a name="libglbarcode-3.0-lgl-barcode-create.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">
-#include &lt;libglbarcode/lgl-barcode-create.h&gt;
-
-<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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>);
+<div class="refsect1">
+<a name="libglbarcode-3.0-lgl-barcode-create.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody><tr>
+<td class="function_type">
+<a class="link" href="libglbarcode-3.0-lgl-barcode.html#lglBarcode" title="lglBarcode"><span class="returnvalue">lglBarcode</span></a> *
+</td>
+<td class="function_name">
+<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>
+</td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="libglbarcode-3.0-lgl-barcode-create.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">
+</pre>
+</div>
+<div class="refsect1">
+<a name="libglbarcode-3.0-lgl-barcode-create.includes"></a><h2>Includes</h2>
+<pre class="synopsis">#include &lt;libglbarcode/lgl-barcode-create.h&gt;
 </pre>
 </div>
 <div class="refsect1">
 </pre>
 </div>
 <div class="refsect1">
@@ -56,67 +67,84 @@ barcode backend.
 </p>
 </div>
 <div class="refsect1">
 </p>
 </div>
 <div class="refsect1">
-<a name="libglbarcode-3.0-lgl-barcode-create.details"></a><h2>Details</h2>
+<a name="libglbarcode-3.0-lgl-barcode-create.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
 <div class="refsect2">
-<a name="lgl-barcode-create"></a><h3>lgl_barcode_create ()</h3>
-<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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>,
-                                                         <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>
-<p>
-Create a new barcode structure, encoding <em class="parameter"><code>data</code></em> with selected barcode type and
-characteristics.
-</p>
-<p>
-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 ).
-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
+<a name="lgl-barcode-create"></a><h3>lgl_barcode_create ()</h3>
+<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>,
+                    <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>,
+                    <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>,
+                    <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>,
+                    <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>,
+                    <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>
+<p>Create a new barcode structure, encoding <em class="parameter"><code>data</code></em>
+ with selected barcode type and
+characteristics.</p>
+<p>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 ).
+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
 appropriate for the barcode type and data.  The actual size of the resulting
 barcode may also be limited by required tolerances of line sizes and spacing
 appropriate for the barcode type and data.  The actual size of the resulting
 barcode may also be limited by required tolerances of line sizes and spacing
-for the given barcode type.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
+for the given barcode type.</p>
+<div class="refsect3">
+<a name="id-1.3.3.7.2.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
 <tbody>
 <tr>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
-<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>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>text_flag</code></em> :</span></p></td>
-<td>
-<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>
+<td class="parameter_name"><p>type</p></td>
+<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>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>checksum_flag</code></em> :</span></p></td>
-<td>
-<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>
+<td class="parameter_name"><p>text_flag</p></td>
+<td class="parameter_description"><p><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</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
-<td>Suggested width of barcode</td>
+<td class="parameter_name"><p>checksum_flag</p></td>
+<td class="parameter_description"><p><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</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
-<td>Suggested height of barcode</td>
+<td class="parameter_name"><p>w</p></td>
+<td class="parameter_description"><p>Suggested width of barcode</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
-<td>Data to encode into barcode</td>
+<td class="parameter_name"><p>h</p></td>
+<td class="parameter_description"><p>Suggested height of barcode</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
 </tr>
 <tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<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
-free it.</td>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>Data to encode into barcode</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 </tr>
 </tbody>
 </table></div>
 </div>
+<div class="refsect3">
+<a name="id-1.3.3.7.2.7"></a><h4>Returns</h4>
+<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
+free it.</p>
+<p></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="libglbarcode-3.0-lgl-barcode-create.other_details"></a><h2>Types and Values</h2>
 </div>
 </div>
 <div class="footer">
 <hr>
 </div>
 </div>
 <div class="footer">
 <hr>
-          Generated by GTK-Doc V1.18</div>
+          Generated by GTK-Doc V1.20</div>
 </body>
 </html>
\ No newline at end of file
 </body>
 </html>
\ No newline at end of file