git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-category.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>The lglCategory Structure</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
   8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
   9 <link rel="prev" href="libglabels-3.0-paper.html" title="The lglPaper Structure">
  10 <link rel="next" href="libglabels-3.0-vendor.html" title="The lglVendor Structure">
  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="libglabels-3.0-paper.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.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">LibGlabels 3.0 Reference Manual</th>
  21 <td><a accesskey="n" href="libglabels-3.0-vendor.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="#libglabels-3.0-category.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-category.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-category"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libglabels-3.0-category.top_of_page"></a>The lglCategory Structure</span></h2>
  34 <p>The lglCategory Structure — Template category definitions</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-category.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-category.h&gt;
  42
  43 struct              <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory">lglCategory</a>;
  44 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       <a class="link" href="libglabels-3.0-category.html#lgl-category-new" title="lgl_category_new ()">lgl_category_new</a>                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
  45                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
  46 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       <a class="link" href="libglabels-3.0-category.html#lgl-category-dup" title="lgl_category_dup ()">lgl_category_dup</a>                    (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *orig</code></em>);
  47 <span class="returnvalue">void</span>                <a class="link" href="libglabels-3.0-category.html#lgl-category-free" title="lgl_category_free ()">lgl_category_free</a>                   (<em class="parameter"><code><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *category</code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="libglabels-3.0-category.description"></a><h2>Description</h2>
  52 <p>
  53 This section describes a structure for representing a category of stationary and related
  54 functions.
  55 </p>
  56 </div>
  57 <div class="refsect1">
  58 <a name="libglabels-3.0-category.details"></a><h2>Details</h2>
  59 <div class="refsect2">
  60 <a name="lglCategory"></a><h3>struct lglCategory</h3>
  61 <pre class="programlisting">struct lglCategory {
  62         gchar               *id;     /* Unique ID of category */
  63         gchar               *name;   /* Localized name of category */
  64 };
  65 </pre>
  66 <p>
  67 This structure defines a category.
  68 </p>
  69 <div class="variablelist"><table border="0">
  70 <col align="left" valign="top">
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglCategory.id"></a>id</code></em>;</span></p></td>
  74 <td>Category ID.</td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglCategory.name"></a>name</code></em>;</span></p></td>
  78 <td>Localized category name.</td>
  79 </tr>
  80 </tbody>
  81 </table></div>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="lgl-category-new"></a><h3>lgl_category_new ()</h3>
  86 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       lgl_category_new                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
  87                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
  88 <p>
  89 Allocates and constructs a new <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.
  90 </p>
  91 <div class="variablelist"><table border="0">
  92 <col align="left" valign="top">
  93 <tbody>
  94 <tr>
  95 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
  96 <td>Id of category definition. (E.g. label, card, etc.)  Should be
  97 unique.</td>
  98 </tr>
  99 <tr>
 100 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 101 <td>Localized name of category.</td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 105 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</td>
 106 </tr>
 107 </tbody>
 108 </table></div>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="lgl-category-dup"></a><h3>lgl_category_dup ()</h3>
 113 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       lgl_category_dup                    (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *orig</code></em>);</pre>
 114 <p>
 115 Duplicates an existing <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.
 116 </p>
 117 <div class="variablelist"><table border="0">
 118 <col align="left" valign="top">
 119 <tbody>
 120 <tr>
 121 <td><p><span class="term"><em class="parameter"><code>orig</code></em> :</span></p></td>
 122 <td>
 123 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure to be duplicated.</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td>a pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</td>
 128 </tr>
 129 </tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="lgl-category-free"></a><h3>lgl_category_free ()</h3>
 135 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_category_free                   (<em class="parameter"><code><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *category</code></em>);</pre>
 136 <p>
 137 Free all memory associated with an existing <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.
 138 </p>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody><tr>
 142 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
 143 <td>pointer to <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure to be freed.</td>
 144 </tr></tbody>
 145 </table></div>
 146 </div>
 147 </div>
 148 </div>
 149 <div class="footer">
 150 <hr>
 151           Generated by GTK-Doc V1.17</div>
 152 </body>
 153 </html>