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: LibGlabels 3.0 Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.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="#libglabels-3.0-category.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="libglabels-3.0-paper.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libglabels-3.0-vendor.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="libglabels-3.0-category"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libglabels-3.0-category.top_of_page"></a>The lglCategory Structure</span></h2>
  30 <p>The lglCategory Structure — Template category definitions</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libglabels-3.0-category.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>
  42 <tr>
  43 <td class="function_type">
  44 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="libglabels-3.0-category.html#lgl-category-new" title="lgl_category_new ()">lgl_category_new</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="libglabels-3.0-category.html#lgl-category-dup" title="lgl_category_dup ()">lgl_category_dup</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <span class="returnvalue">void</span>
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="libglabels-3.0-category.html#lgl-category-free" title="lgl_category_free ()">lgl_category_free</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 </tbody>
  67 </table></div>
  68 </div>
  69 <div class="refsect1">
  70 <a name="libglabels-3.0-category.other"></a><h2>Types and Values</h2>
  71 <div class="informaltable"><table width="100%" border="0">
  72 <colgroup>
  73 <col width="150px" class="name">
  74 <col class="description">
  75 </colgroup>
  76 <tbody><tr>
  77 <td class="datatype_keyword">struct</td>
  78 <td class="function_name"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory">lglCategory</a></td>
  79 </tr></tbody>
  80 </table></div>
  81 </div>
  82 <div class="refsect1">
  83 <a name="libglabels-3.0-category.includes"></a><h2>Includes</h2>
  84 <pre class="synopsis">#include &lt;libglabels/lgl-category.h&gt;
  85 </pre>
  86 </div>
  87 <div class="refsect1">
  88 <a name="libglabels-3.0-category.description"></a><h2>Description</h2>
  89 <p>
  90 This section describes a structure for representing a category of stationary and related
  91 functions.
  92 </p>
  93 </div>
  94 <div class="refsect1">
  95 <a name="libglabels-3.0-category.functions_details"></a><h2>Functions</h2>
  96 <div class="refsect2">
  97 <a name="lgl-category-new"></a><h3>lgl_category_new ()</h3>
  98 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
  99 lgl_category_new (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
 100                   <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 101 <p>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.</p>
 102 <div class="refsect3">
 103 <a name="id-1.2.5.7.2.5"></a><h4>Parameters</h4>
 104 <div class="informaltable"><table width="100%" border="0">
 105 <colgroup>
 106 <col width="150px" class="parameters_name">
 107 <col class="parameters_description">
 108 <col width="200px" class="parameters_annotations">
 109 </colgroup>
 110 <tbody>
 111 <tr>
 112 <td class="parameter_name"><p>id</p></td>
 113 <td class="parameter_description"><p>Id of category definition. (E.g. label, card, etc.)  Should be
 114 unique.</p></td>
 115 <td class="parameter_annotations"> </td>
 116 </tr>
 117 <tr>
 118 <td class="parameter_name"><p>name</p></td>
 119 <td class="parameter_description"><p>Localized name of category.</p></td>
 120 <td class="parameter_annotations"> </td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <div class="refsect3">
 126 <a name="id-1.2.5.7.2.6"></a><h4>Returns</h4>
 127 <p> 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.</p>
 128 </div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="lgl-category-dup"></a><h3>lgl_category_dup ()</h3>
 133 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
 134 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>
 135 <p>Duplicates an existing <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
 136 <div class="refsect3">
 137 <a name="id-1.2.5.7.3.5"></a><h4>Parameters</h4>
 138 <div class="informaltable"><table width="100%" border="0">
 139 <colgroup>
 140 <col width="150px" class="parameters_name">
 141 <col class="parameters_description">
 142 <col width="200px" class="parameters_annotations">
 143 </colgroup>
 144 <tbody><tr>
 145 <td class="parameter_name"><p>orig</p></td>
 146 <td class="parameter_description"><p><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure to be duplicated.</p></td>
 147 <td class="parameter_annotations"> </td>
 148 </tr></tbody>
 149 </table></div>
 150 </div>
 151 <div class="refsect3">
 152 <a name="id-1.2.5.7.3.6"></a><h4>Returns</h4>
 153 <p> 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.</p>
 154 </div>
 155 </div>
 156 <hr>
 157 <div class="refsect2">
 158 <a name="lgl-category-free"></a><h3>lgl_category_free ()</h3>
 159 <pre class="programlisting"><span class="returnvalue">void</span>
 160 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>
 161 <p>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.</p>
 162 <div class="refsect3">
 163 <a name="id-1.2.5.7.4.5"></a><h4>Parameters</h4>
 164 <div class="informaltable"><table width="100%" border="0">
 165 <colgroup>
 166 <col width="150px" class="parameters_name">
 167 <col class="parameters_description">
 168 <col width="200px" class="parameters_annotations">
 169 </colgroup>
 170 <tbody><tr>
 171 <td class="parameter_name"><p>category</p></td>
 172 <td class="parameter_description"><p>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.</p></td>
 173 <td class="parameter_annotations"> </td>
 174 </tr></tbody>
 175 </table></div>
 176 </div>
 177 </div>
 178 </div>
 179 <div class="refsect1">
 180 <a name="libglabels-3.0-category.other_details"></a><h2>Types and Values</h2>
 181 <div class="refsect2">
 182 <a name="lglCategory"></a><h3>struct lglCategory</h3>
 183 <pre class="programlisting">struct lglCategory {
 184         gchar               *id;     /* Unique ID of category */
 185         gchar               *name;   /* Localized name of category */
 186 };
 187 </pre>
 188 <p>
 189 This structure defines a category.
 190 </p>
 191 <div class="refsect3">
 192 <a name="id-1.2.5.8.2.5"></a><h4>Members</h4>
 193 <div class="informaltable"><table width="100%" border="0">
 194 <colgroup>
 195 <col width="300px" class="struct_members_name">
 196 <col class="struct_members_description">
 197 <col width="200px" class="struct_members_annotations">
 198 </colgroup>
 199 <tbody>
 200 <tr>
 201 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 202 <td class="struct_member_description"><p>Category ID.</p></td>
 203 <td class="struct_member_annotations"> </td>
 204 </tr>
 205 <tr>
 206 <td class="struct_member_name"><p><a href="https://developer.gnome.org/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>;</p></td>
 207 <td class="struct_member_description"><p>Localized category name.</p></td>
 208 <td class="struct_member_annotations"> </td>
 209 </tr>
 210 </tbody>
 211 </table></div>
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216 <div class="footer">
 217 <hr>Generated by GTK-Doc V1.24</div>
 218 </body>
 219 </html>