]> git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-template.html
Imported Upstream version 2.2.8
[glabels] / docs / libglabels / html / libglabels-template.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 lglTemplate Structure</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="LibGlabels Reference Manual">
8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
9 <link rel="prev" href="libglabels-db.html" title="Database">
10 <link rel="next" href="libglabels-paper.html" title="The lglPaper Structure">
11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 <link rel="chapter" href="ch01.html" title="Basic LibGlabels Usage">
14 <link rel="chapter" href="ch02.html" title="Working Directly With LibGlabels XML">
15 <link rel="chapter" href="ch03.html" title="Miscellaneous">
16 </head>
17 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
19 <tr valign="middle">
20 <td><a accesskey="p" href="libglabels-db.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23 <th width="100%" align="center">LibGlabels Reference Manual</th>
24 <td><a accesskey="n" href="libglabels-paper.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
25 </tr>
26 <tr><td colspan="5" class="shortcuts">
27 <a href="#libglabels-template.synopsis" class="shortcut">Top</a>
28                  | 
29                 <a href="#libglabels-template.description" class="shortcut">Description</a>
30 </td></tr>
31 </table>
32 <div class="refentry" title="The lglTemplate Structure">
33 <a name="libglabels-template"></a><div class="titlepage"></div>
34 <div class="refnamediv"><table width="100%"><tr>
35 <td valign="top">
36 <h2><span class="refentrytitle"><a name="libglabels-template.top_of_page"></a>The lglTemplate Structure</span></h2>
37 <p>The lglTemplate Structure — How templates are represented in memory</p>
38 </td>
39 <td valign="top" align="right"></td>
40 </tr></table></div>
41 <div class="refsynopsisdiv" title="Synopsis">
42 <a name="libglabels-template.synopsis"></a><h2>Synopsis</h2>
43 <pre class="synopsis">
44
45 #include &lt;libglabels/template.h&gt;
46
47                     <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a>;
48
49                     <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a>;
50
51 enum                <a class="link" href="libglabels-template.html#lglTemplateFrameShape" title="enum lglTemplateFrameShape">lglTemplateFrameShape</a>;
52 union               <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a>;
53                     <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll">lglTemplateFrameAll</a>;
54                     <a class="link" href="libglabels-template.html#lglTemplateFrameRect" title="lglTemplateFrameRect">lglTemplateFrameRect</a>;
55                     <a class="link" href="libglabels-template.html#lglTemplateFrameRound" title="lglTemplateFrameRound">lglTemplateFrameRound</a>;
56                     <a class="link" href="libglabels-template.html#lglTemplateFrameCD" title="lglTemplateFrameCD">lglTemplateFrameCD</a>;
57
58                     <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a>;
59
60 enum                <a class="link" href="libglabels-template.html#lglTemplateMarkupType" title="enum lglTemplateMarkupType">lglTemplateMarkupType</a>;
61 union               <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a>;
62                     <a class="link" href="libglabels-template.html#lglTemplateMarkupMargin" title="lglTemplateMarkupMargin">lglTemplateMarkupMargin</a>;
63                     <a class="link" href="libglabels-template.html#lglTemplateMarkupLine" title="lglTemplateMarkupLine">lglTemplateMarkupLine</a>;
64                     <a class="link" href="libglabels-template.html#lglTemplateMarkupCircle" title="lglTemplateMarkupCircle">lglTemplateMarkupCircle</a>;
65                     <a class="link" href="libglabels-template.html#lglTemplateMarkupRect" title="lglTemplateMarkupRect">lglTemplateMarkupRect</a>;
66
67                     <a class="link" href="libglabels-template.html#lglTemplateOrigin" title="lglTemplateOrigin">lglTemplateOrigin</a>;
68
69 <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       <a class="link" href="libglabels-template.html#lgl-template-new" title="lgl_template_new ()">lgl_template_new</a>                    (const <a
70 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
71 >gchar</a> *brand,
72                                                          const <a
73 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
74 >gchar</a> *part,
75                                                          const <a
76 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
77 >gchar</a> *description,
78                                                          const <a
79 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
80 >gchar</a> *paper_id,
81                                                          <a
82 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
83 >gdouble</a> page_width,
84                                                          <a
85 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
86 >gdouble</a> page_height);
87 <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       <a class="link" href="libglabels-template.html#lgl-template-dup" title="lgl_template_dup ()">lgl_template_dup</a>                    (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *orig_template);
88 void                <a class="link" href="libglabels-template.html#lgl-template-free" title="lgl_template_free ()">lgl_template_free</a>                   (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);
89 void                <a class="link" href="libglabels-template.html#lgl-template-add-category" title="lgl_template_add_category ()">lgl_template_add_category</a>           (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
90                                                          const <a
91 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
92 >gchar</a> *category_id);
93 void                <a class="link" href="libglabels-template.html#lgl-template-add-frame" title="lgl_template_add_frame ()">lgl_template_add_frame</a>              (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
94                                                          <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);
95 void                <a class="link" href="libglabels-template.html#lgl-template-add-alias" title="lgl_template_add_alias ()">lgl_template_add_alias</a>              (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
96                                                          <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *alias);
97
98 <a
99 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
100 >gchar</a> *             <a class="link" href="libglabels-template.html#lgl-template-get-name" title="lgl_template_get_name ()">lgl_template_get_name</a>               (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);
101 <a
102 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
103 >gboolean</a>            <a class="link" href="libglabels-template.html#lgl-template-do-templates-match" title="lgl_template_do_templates_match ()">lgl_template_do_templates_match</a>     (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template1,
104                                                          const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template2);
105 <a
106 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
107 >gboolean</a>            <a class="link" href="libglabels-template.html#lgl-template-does-brand-match" title="lgl_template_does_brand_match ()">lgl_template_does_brand_match</a>       (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
108                                                          const <a
109 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
110 >gchar</a> *brand);
111 <a
112 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
113 >gboolean</a>            <a class="link" href="libglabels-template.html#lgl-template-does-page-size-match" title="lgl_template_does_page_size_match ()">lgl_template_does_page_size_match</a>   (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
114                                                          const <a
115 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
116 >gchar</a> *paper_id);
117 <a
118 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
119 >gboolean</a>            <a class="link" href="libglabels-template.html#lgl-template-does-category-match" title="lgl_template_does_category_match ()">lgl_template_does_category_match</a>    (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
120                                                          const <a
121 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
122 >gchar</a> *category_id);
123
124 <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *  <a class="link" href="libglabels-template.html#lgl-template-alias-new" title="lgl_template_alias_new ()">lgl_template_alias_new</a>              (const <a
125 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
126 >gchar</a> *brand,
127                                                          const <a
128 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
129 >gchar</a> *part);
130 <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *  <a class="link" href="libglabels-template.html#lgl-template-alias-dup" title="lgl_template_alias_dup ()">lgl_template_alias_dup</a>              (const <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *orig_alias);
131 void                <a class="link" href="libglabels-template.html#lgl-template-alias-free" title="lgl_template_alias_free ()">lgl_template_alias_free</a>             (<a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *alias);
132
133 <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  <a class="link" href="libglabels-template.html#lgl-template-frame-rect-new" title="lgl_template_frame_rect_new ()">lgl_template_frame_rect_new</a>         (const <a
134 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
135 >gchar</a> *id,
136                                                          <a
137 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
138 >gdouble</a> w,
139                                                          <a
140 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
141 >gdouble</a> h,
142                                                          <a
143 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
144 >gdouble</a> r,
145                                                          <a
146 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
147 >gdouble</a> x_waste,
148                                                          <a
149 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
150 >gdouble</a> y_waste);
151 <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  <a class="link" href="libglabels-template.html#lgl-template-frame-round-new" title="lgl_template_frame_round_new ()">lgl_template_frame_round_new</a>        (const <a
152 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
153 >gchar</a> *id,
154                                                          <a
155 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
156 >gdouble</a> r,
157                                                          <a
158 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
159 >gdouble</a> waste);
160 <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  <a class="link" href="libglabels-template.html#lgl-template-frame-cd-new" title="lgl_template_frame_cd_new ()">lgl_template_frame_cd_new</a>           (const <a
161 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
162 >gchar</a> *id,
163                                                          <a
164 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
165 >gdouble</a> r1,
166                                                          <a
167 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
168 >gdouble</a> r2,
169                                                          <a
170 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
171 >gdouble</a> w,
172                                                          <a
173 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
174 >gdouble</a> h,
175                                                          <a
176 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
177 >gdouble</a> waste);
178 <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  <a class="link" href="libglabels-template.html#lgl-template-frame-dup" title="lgl_template_frame_dup ()">lgl_template_frame_dup</a>              (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *orig_frame);
179 void                <a class="link" href="libglabels-template.html#lgl-template-frame-free" title="lgl_template_frame_free ()">lgl_template_frame_free</a>             (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);
180 void                <a class="link" href="libglabels-template.html#lgl-template-frame-add-layout" title="lgl_template_frame_add_layout ()">lgl_template_frame_add_layout</a>       (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
181                                                          <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *layout);
182 void                <a class="link" href="libglabels-template.html#lgl-template-frame-add-markup" title="lgl_template_frame_add_markup ()">lgl_template_frame_add_markup</a>       (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
183                                                          <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *markup);
184
185 void                <a class="link" href="libglabels-template.html#lgl-template-frame-get-size" title="lgl_template_frame_get_size ()">lgl_template_frame_get_size</a>         (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
186                                                          <a
187 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
188 >gdouble</a> *w,
189                                                          <a
190 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
191 >gdouble</a> *h);
192 <a
193 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
194 >gint</a>                <a class="link" href="libglabels-template.html#lgl-template-frame-get-n-labels" title="lgl_template_frame_get_n_labels ()">lgl_template_frame_get_n_labels</a>     (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);
195 <a class="link" href="libglabels-template.html#lglTemplateOrigin" title="lglTemplateOrigin">lglTemplateOrigin</a> * <a class="link" href="libglabels-template.html#lgl-template-frame-get-origins" title="lgl_template_frame_get_origins ()">lgl_template_frame_get_origins</a>      (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);
196
197 <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> * <a class="link" href="libglabels-template.html#lgl-template-layout-new" title="lgl_template_layout_new ()">lgl_template_layout_new</a>             (<a
198 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
199 >gint</a> nx,
200                                                          <a
201 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
202 >gint</a> ny,
203                                                          <a
204 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
205 >gdouble</a> x0,
206                                                          <a
207 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
208 >gdouble</a> y0,
209                                                          <a
210 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
211 >gdouble</a> dx,
212                                                          <a
213 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
214 >gdouble</a> dy);
215 <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> * <a class="link" href="libglabels-template.html#lgl-template-layout-dup" title="lgl_template_layout_dup ()">lgl_template_layout_dup</a>             (const <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *orig_layout);
216 void                <a class="link" href="libglabels-template.html#lgl-template-layout-free" title="lgl_template_layout_free ()">lgl_template_layout_free</a>            (<a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *layout);
217
218 <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * <a class="link" href="libglabels-template.html#lgl-template-markup-margin-new" title="lgl_template_markup_margin_new ()">lgl_template_markup_margin_new</a>      (<a
219 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
220 >gdouble</a> size);
221 <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * <a class="link" href="libglabels-template.html#lgl-template-markup-line-new" title="lgl_template_markup_line_new ()">lgl_template_markup_line_new</a>        (<a
222 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
223 >gdouble</a> x1,
224                                                          <a
225 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
226 >gdouble</a> y1,
227                                                          <a
228 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
229 >gdouble</a> x2,
230                                                          <a
231 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
232 >gdouble</a> y2);
233 <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * <a class="link" href="libglabels-template.html#lgl-template-markup-circle-new" title="lgl_template_markup_circle_new ()">lgl_template_markup_circle_new</a>      (<a
234 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
235 >gdouble</a> x0,
236                                                          <a
237 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
238 >gdouble</a> y0,
239                                                          <a
240 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
241 >gdouble</a> r);
242 <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * <a class="link" href="libglabels-template.html#lgl-template-markup-rect-new" title="lgl_template_markup_rect_new ()">lgl_template_markup_rect_new</a>        (<a
243 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
244 >gdouble</a> x1,
245                                                          <a
246 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
247 >gdouble</a> y1,
248                                                          <a
249 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
250 >gdouble</a> w,
251                                                          <a
252 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
253 >gdouble</a> h,
254                                                          <a
255 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
256 >gdouble</a> r);
257 <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * <a class="link" href="libglabels-template.html#lgl-template-markup-dup" title="lgl_template_markup_dup ()">lgl_template_markup_dup</a>             (const <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *orig_markup);
258 void                <a class="link" href="libglabels-template.html#lgl-template-markup-free" title="lgl_template_markup_free ()">lgl_template_markup_free</a>            (<a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *markup);
259 </pre>
260 </div>
261 <div class="refsect1" title="Description">
262 <a name="libglabels-template.description"></a><h2>Description</h2>
263 <p>
264 This section describes a set of structures that represent a template in memory.  It also
265 describes functions to help create and interpret these structures.
266 </p>
267 </div>
268 <div class="refsect1" title="Details">
269 <a name="libglabels-template.details"></a><h2>Details</h2>
270 <div class="refsect2" title="lglTemplate">
271 <a name="lglTemplate"></a><h3>lglTemplate</h3>
272 <pre class="programlisting">typedef struct {
273         gchar               *brand;
274         gchar               *part;
275         gchar               *description;
276         gchar               *paper_id;
277         gdouble              page_width;
278         gdouble              page_height;
279
280         /* List of (lglTemplateAlias *) aliase structures. */
281         GList               *aliases;
282
283         /* List of (gchar *) category ids. */
284         GList               *category_ids;
285
286         /* List of (lglTemplateFrame *) label frame structures.
287          * Currently glabels only supports a single label frame per
288          * template. */
289         GList               *frames;
290 } lglTemplate;
291 </pre>
292 <p>
293 This is the main structure of a libglabels template.  A template represents a single sheet
294 of peel-off labels or cards.
295 </p>
296 <div class="variablelist"><table border="0">
297 <col align="left" valign="top">
298 <tbody>
299 <tr>
300 <td><p><span class="term"><a
301 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
302 >gchar</a> *<em class="structfield"><code>brand</code></em>;</span></p></td>
303 <td>Brand name of label or card.  E.g. "Avery."
304 </td>
305 </tr>
306 <tr>
307 <td><p><span class="term"><a
308 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
309 >gchar</a> *<em class="structfield"><code>part</code></em>;</span></p></td>
310 <td>Part name or number of label or card.  E.g. "8160."
311 </td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><a
315 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
316 >gchar</a> *<em class="structfield"><code>description</code></em>;</span></p></td>
317 <td>A description of the template.  E.g. "Mailing labels."
318 </td>
319 </tr>
320 <tr>
321 <td><p><span class="term"><a
322 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
323 >gchar</a> *<em class="structfield"><code>paper_id</code></em>;</span></p></td>
324 <td>A paper ID.  E.g. "A4" or "US-Letter."
325 </td>
326 </tr>
327 <tr>
328 <td><p><span class="term"><a
329 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
330 >gdouble</a> <em class="structfield"><code>page_width</code></em>;</span></p></td>
331 <td>Page width in points.  Used only if paper_id is "Other."
332 </td>
333 </tr>
334 <tr>
335 <td><p><span class="term"><a
336 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
337 >gdouble</a> <em class="structfield"><code>page_height</code></em>;</span></p></td>
338 <td>Page height in points.  Used only if paper_id is "Other."
339 </td>
340 </tr>
341 <tr>
342 <td><p><span class="term"><a
343 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
344 >GList</a> *<em class="structfield"><code>aliases</code></em>;</span></p></td>
345 <td>A list of alternate names for this template.  Often a single template can be used for
346 multiple products.
347 </td>
348 </tr>
349 <tr>
350 <td><p><span class="term"><a
351 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
352 >GList</a> *<em class="structfield"><code>category_ids</code></em>;</span></p></td>
353 <td>A list of category IDs that this template belongs to.
354 </td>
355 </tr>
356 <tr>
357 <td><p><span class="term"><a
358 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
359 >GList</a> *<em class="structfield"><code>frames</code></em>;</span></p></td>
360 <td>A list of (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> *) structures.  GLabels currently only supports one frame
361 per template -- future versions may support multiple frames per template.
362 </td>
363 </tr>
364 </tbody>
365 </table></div>
366 </div>
367 <hr>
368 <div class="refsect2" title="lglTemplateAlias">
369 <a name="lglTemplateAlias"></a><h3>lglTemplateAlias</h3>
370 <pre class="programlisting">typedef struct {
371         gchar               *brand;
372         gchar               *part;
373 } lglTemplateAlias;
374 </pre>
375 <p>
376 This structure defines an alias for the parent template structure.  An alias is used for
377 different products that can use the same template.
378 </p>
379 <div class="variablelist"><table border="0">
380 <col align="left" valign="top">
381 <tbody>
382 <tr>
383 <td><p><span class="term"><a
384 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
385 >gchar</a> *<em class="structfield"><code>brand</code></em>;</span></p></td>
386 <td>Brand name of label or card.  E.g. "Avery."
387 </td>
388 </tr>
389 <tr>
390 <td><p><span class="term"><a
391 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
392 >gchar</a> *<em class="structfield"><code>part</code></em>;</span></p></td>
393 <td>Part name or number of label or card.  E.g. "8160."
394 </td>
395 </tr>
396 </tbody>
397 </table></div>
398 </div>
399 <hr>
400 <div class="refsect2" title="enum lglTemplateFrameShape">
401 <a name="lglTemplateFrameShape"></a><h3>enum lglTemplateFrameShape</h3>
402 <pre class="programlisting">typedef enum {
403         LGL_TEMPLATE_FRAME_SHAPE_RECT,
404         LGL_TEMPLATE_FRAME_SHAPE_ROUND,
405         LGL_TEMPLATE_FRAME_SHAPE_CD,
406 } lglTemplateFrameShape;
407 </pre>
408 <p>
409 This enumeration defines frame types that are supported by libglabels
410 </p>
411 <div class="variablelist"><table border="0">
412 <col align="left" valign="top">
413 <tbody>
414 <tr>
415 <td><p><a name="LGL-TEMPLATE-FRAME-SHAPE-RECT--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_FRAME_SHAPE_RECT</code></span></p></td>
416 <td>A rectangular frame.  (May have rounded corners.)
417 </td>
418 </tr>
419 <tr>
420 <td><p><a name="LGL-TEMPLATE-FRAME-SHAPE-ROUND--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_FRAME_SHAPE_ROUND</code></span></p></td>
421 <td>A round frame.
422 </td>
423 </tr>
424 <tr>
425 <td><p><a name="LGL-TEMPLATE-FRAME-SHAPE-CD--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_FRAME_SHAPE_CD</code></span></p></td>
426 <td>A CD or DVD frame.  (Includes credit-card style CDs.)
427 </td>
428 </tr>
429 </tbody>
430 </table></div>
431 </div>
432 <hr>
433 <div class="refsect2" title="union lglTemplateFrame">
434 <a name="lglTemplateFrame"></a><h3>union lglTemplateFrame</h3>
435 <pre class="programlisting">union lglTemplateFrame{
436
437         lglTemplateFrameShape shape;
438
439         lglTemplateFrameAll   all;
440         lglTemplateFrameRect  rect;
441         lglTemplateFrameRound round;
442         lglTemplateFrameCD    cd;
443 };
444 </pre>
445 <p>
446 A union of all possible frame structures.  The type of structure is indicated by the shape
447 member, which overlays the first field of all other member structures.
448 </p>
449 </div>
450 <hr>
451 <div class="refsect2" title="lglTemplateFrameAll">
452 <a name="lglTemplateFrameAll"></a><h3>lglTemplateFrameAll</h3>
453 <pre class="programlisting">typedef struct {
454         /* Begin Common Fields */
455         lglTemplateFrameShape shape;
456
457         gchar                *id;       /* Id, currently always "0" */
458         GList                *layouts;  /* List of lglTemplateLayouts */
459         GList                *markups;  /* List of lglTemplateMarkups */
460         /* End Common Fields */
461 } lglTemplateFrameAll;
462 </pre>
463 <p>
464 This structure is composed of a set of fields common to all frame structures.  All frame types
465 can be cast to this structure.
466 </p>
467 <div class="variablelist"><table border="0">
468 <col align="left" valign="top">
469 <tbody>
470 <tr>
471 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateFrameShape" title="enum lglTemplateFrameShape">lglTemplateFrameShape</a> <em class="structfield"><code>shape</code></em>;</span></p></td>
472 <td>The shape of the frame.
473 </td>
474 </tr>
475 <tr>
476 <td><p><span class="term"><a
477 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
478 >gchar</a> *<em class="structfield"><code>id</code></em>;</span></p></td>
479 <td>Reserved for future use.  Should always be zero.
480 </td>
481 </tr>
482 <tr>
483 <td><p><span class="term"><a
484 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
485 >GList</a> *<em class="structfield"><code>layouts</code></em>;</span></p></td>
486 <td>A list of (<a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout"><span class="type">lglTemplateLayout</span></a> *) structures.  Typically a frame will have a single
487 layout, representing a simple grid of labels or cards.  If the layout of labels or cards is
488 more complex, multiple (<a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout"><span class="type">lglTemplateLayout</span></a> *) structures may be needed.
489 </td>
490 </tr>
491 <tr>
492 <td><p><span class="term"><a
493 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
494 >GList</a> *<em class="structfield"><code>markups</code></em>;</span></p></td>
495 <td>A list of (<a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> *) structures, which represent non-printing markup lines.
496 </td>
497 </tr>
498 </tbody>
499 </table></div>
500 </div>
501 <hr>
502 <div class="refsect2" title="lglTemplateFrameRect">
503 <a name="lglTemplateFrameRect"></a><h3>lglTemplateFrameRect</h3>
504 <pre class="programlisting">typedef struct {
505         /* Begin Common Fields */
506         lglTemplateFrameShape shape;    /* Always LGL_TEMPLATE_FRAME_SHAPE_RECT. */
507
508         gchar                *id;       /* Id, currently always "0" */
509         GList                *layouts;  /* List of lglTemplateLayouts */
510         GList                *markups;  /* List of lglTemplateMarkups */
511         /* End Common Fields */
512
513         gdouble               w;        /* Width */
514         gdouble               h;        /* Height */
515         gdouble               r;        /* Corner radius */
516         gdouble               x_waste;  /* Amount of horiz overprint allowed. */
517         gdouble               y_waste;  /* Amount of vert overprint allowed. */
518 } lglTemplateFrameRect;
519 </pre>
520 <p>
521 This structure defines the frame for a rectangular label or card.
522 </p>
523 <div class="variablelist"><table border="0">
524 <col align="left" valign="top">
525 <tbody>
526 <tr>
527 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateFrameShape" title="enum lglTemplateFrameShape">lglTemplateFrameShape</a> <em class="structfield"><code>shape</code></em>;</span></p></td>
528 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-FRAME-SHAPE-RECT--CAPS"><span class="type">LGL_TEMPLATE_FRAME_SHAPE_RECT</span></a> for <a class="link" href="libglabels-template.html#lglTemplateFrameRect" title="lglTemplateFrameRect"><span class="type">lglTemplateFrameRect</span></a>.
529 </td>
530 </tr>
531 <tr>
532 <td><p><span class="term"><a
533 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
534 >gchar</a> *<em class="structfield"><code>id</code></em>;</span></p></td>
535 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
536 </td>
537 </tr>
538 <tr>
539 <td><p><span class="term"><a
540 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
541 >GList</a> *<em class="structfield"><code>layouts</code></em>;</span></p></td>
542 <td> Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
543 </td>
544 </tr>
545 <tr>
546 <td><p><span class="term"><a
547 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
548 >GList</a> *<em class="structfield"><code>markups</code></em>;</span></p></td>
549 <td> Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
550 </td>
551 </tr>
552 <tr>
553 <td><p><span class="term"><a
554 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
555 >gdouble</a> <em class="structfield"><code>w</code></em>;</span></p></td>
556 <td>Width of label or card in points.
557 </td>
558 </tr>
559 <tr>
560 <td><p><span class="term"><a
561 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
562 >gdouble</a> <em class="structfield"><code>h</code></em>;</span></p></td>
563 <td>Height of label or card in points.
564 </td>
565 </tr>
566 <tr>
567 <td><p><span class="term"><a
568 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
569 >gdouble</a> <em class="structfield"><code>r</code></em>;</span></p></td>
570 <td>Radius of corners in points.
571 </td>
572 </tr>
573 <tr>
574 <td><p><span class="term"><a
575 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
576 >gdouble</a> <em class="structfield"><code>x_waste</code></em>;</span></p></td>
577 <td>Amount of horizontal over-print to allow in points.
578 </td>
579 </tr>
580 <tr>
581 <td><p><span class="term"><a
582 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
583 >gdouble</a> <em class="structfield"><code>y_waste</code></em>;</span></p></td>
584 <td>Amount of vertical over-print to allow in points.
585 </td>
586 </tr>
587 </tbody>
588 </table></div>
589 </div>
590 <hr>
591 <div class="refsect2" title="lglTemplateFrameRound">
592 <a name="lglTemplateFrameRound"></a><h3>lglTemplateFrameRound</h3>
593 <pre class="programlisting">typedef struct {
594         /* Begin Common Fields */
595         lglTemplateFrameShape shape;    /* Always LGL_TEMPLATE_FRAME_SHAPE_ROUND. */
596
597         gchar                *id;       /* Id, currently always "0" */
598         GList                *layouts;  /* List of lglTemplateLayouts */
599         GList                *markups;  /* List of lglTemplateMarkups */
600         /* End Common Fields */
601
602         gdouble               r;      /* Radius */
603         gdouble               waste;  /* Amount of overprint allowed. */
604 } lglTemplateFrameRound;
605 </pre>
606 <p>
607 This structure defines the frame for a round label or card.
608 </p>
609 <div class="variablelist"><table border="0">
610 <col align="left" valign="top">
611 <tbody>
612 <tr>
613 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateFrameShape" title="enum lglTemplateFrameShape">lglTemplateFrameShape</a> <em class="structfield"><code>shape</code></em>;</span></p></td>
614 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-FRAME-SHAPE-ROUND--CAPS"><span class="type">LGL_TEMPLATE_FRAME_SHAPE_ROUND</span></a> for <a class="link" href="libglabels-template.html#lglTemplateFrameRound" title="lglTemplateFrameRound"><span class="type">lglTemplateFrameRound</span></a>.
615 </td>
616 </tr>
617 <tr>
618 <td><p><span class="term"><a
619 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
620 >gchar</a> *<em class="structfield"><code>id</code></em>;</span></p></td>
621 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
622 </td>
623 </tr>
624 <tr>
625 <td><p><span class="term"><a
626 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
627 >GList</a> *<em class="structfield"><code>layouts</code></em>;</span></p></td>
628 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
629 </td>
630 </tr>
631 <tr>
632 <td><p><span class="term"><a
633 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
634 >GList</a> *<em class="structfield"><code>markups</code></em>;</span></p></td>
635 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
636 </td>
637 </tr>
638 <tr>
639 <td><p><span class="term"><a
640 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
641 >gdouble</a> <em class="structfield"><code>r</code></em>;</span></p></td>
642 <td>Radius of label or card in points.
643 </td>
644 </tr>
645 <tr>
646 <td><p><span class="term"><a
647 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
648 >gdouble</a> <em class="structfield"><code>waste</code></em>;</span></p></td>
649 <td>Amount of over-print to allow in points.
650 </td>
651 </tr>
652 </tbody>
653 </table></div>
654 </div>
655 <hr>
656 <div class="refsect2" title="lglTemplateFrameCD">
657 <a name="lglTemplateFrameCD"></a><h3>lglTemplateFrameCD</h3>
658 <pre class="programlisting">typedef struct {
659         /* Begin Common Fields */
660         lglTemplateFrameShape shape;    /* Always LGL_TEMPLATE_FRAME_SHAPE_CD. */
661
662         gchar                *id;       /* Id, currently always "0" */
663         GList                *layouts;  /* List of lglTemplateLayouts */
664         GList                *markups;  /* List of lglTemplateMarkups */
665         /* End Common Fields */
666
667         gdouble               r1;     /* Outer radius */
668         gdouble               r2;     /* Inner radius (hole) */
669         gdouble               w;      /* Clip width, business card CDs */
670         gdouble               h;      /* Clip height, business card CDs */
671         gdouble               waste;  /* Amount of overprint allowed. */
672 } lglTemplateFrameCD;
673 </pre>
674 <p>
675 This structure defines the frame for a CD or DVD label.  This structure also supports
676 credit-card CD labels.
677 </p>
678 <div class="variablelist"><table border="0">
679 <col align="left" valign="top">
680 <tbody>
681 <tr>
682 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateFrameShape" title="enum lglTemplateFrameShape">lglTemplateFrameShape</a> <em class="structfield"><code>shape</code></em>;</span></p></td>
683 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-FRAME-SHAPE-CD--CAPS"><span class="type">LGL_TEMPLATE_FRAME_SHAPE_CD</span></a> for <a class="link" href="libglabels-template.html#lglTemplateFrameCD" title="lglTemplateFrameCD"><span class="type">lglTemplateFrameCD</span></a>.
684 </td>
685 </tr>
686 <tr>
687 <td><p><span class="term"><a
688 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
689 >gchar</a> *<em class="structfield"><code>id</code></em>;</span></p></td>
690 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
691 </td>
692 </tr>
693 <tr>
694 <td><p><span class="term"><a
695 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
696 >GList</a> *<em class="structfield"><code>layouts</code></em>;</span></p></td>
697 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
698 </td>
699 </tr>
700 <tr>
701 <td><p><span class="term"><a
702 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
703 >GList</a> *<em class="structfield"><code>markups</code></em>;</span></p></td>
704 <td>Common field.  See <a class="link" href="libglabels-template.html#lglTemplateFrameAll" title="lglTemplateFrameAll"><span class="type">lglTemplateFrameAll</span></a>.
705 </td>
706 </tr>
707 <tr>
708 <td><p><span class="term"><a
709 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
710 >gdouble</a> <em class="structfield"><code>r1</code></em>;</span></p></td>
711 <td>Outer radius of label in points.
712 </td>
713 </tr>
714 <tr>
715 <td><p><span class="term"><a
716 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
717 >gdouble</a> <em class="structfield"><code>r2</code></em>;</span></p></td>
718 <td>Radius of center hole in points.
719 </td>
720 </tr>
721 <tr>
722 <td><p><span class="term"><a
723 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
724 >gdouble</a> <em class="structfield"><code>w</code></em>;</span></p></td>
725 <td>Clip width in points.  Used for credit-card CD labels.  This field is ignored if zero.
726 </td>
727 </tr>
728 <tr>
729 <td><p><span class="term"><a
730 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
731 >gdouble</a> <em class="structfield"><code>h</code></em>;</span></p></td>
732 <td>Clip height in points.  Used for credit-card CD labels.  This field is ignored if zero.
733 </td>
734 </tr>
735 <tr>
736 <td><p><span class="term"><a
737 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
738 >gdouble</a> <em class="structfield"><code>waste</code></em>;</span></p></td>
739 <td>Amount of over-print to allow in points.
740 </td>
741 </tr>
742 </tbody>
743 </table></div>
744 </div>
745 <hr>
746 <div class="refsect2" title="lglTemplateLayout">
747 <a name="lglTemplateLayout"></a><h3>lglTemplateLayout</h3>
748 <pre class="programlisting">typedef struct {
749         gint                  nx;  /* Number of labels across */
750         gint                  ny;  /* Number of labels up and down */
751
752         gdouble               x0;  /* Left of grid from left edge of paper */
753         gdouble               y0;  /* Top of grid from top edge of paper */
754
755         gdouble               dx;  /* Horizontal pitch of grid */
756         gdouble               dy;  /* Vertical pitch of grid */
757 } lglTemplateLayout;
758 </pre>
759 <p>
760 This structure defines a simple grid layout of labels or cards.
761 </p>
762 <div class="variablelist"><table border="0">
763 <col align="left" valign="top">
764 <tbody>
765 <tr>
766 <td><p><span class="term"><a
767 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
768 >gint</a> <em class="structfield"><code>nx</code></em>;</span></p></td>
769 <td>Number of labels or cards across in the grid (horizontal).
770 </td>
771 </tr>
772 <tr>
773 <td><p><span class="term"><a
774 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
775 >gint</a> <em class="structfield"><code>ny</code></em>;</span></p></td>
776 <td>Number of labels or cards down in the grid (vertical).
777 </td>
778 </tr>
779 <tr>
780 <td><p><span class="term"><a
781 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
782 >gdouble</a> <em class="structfield"><code>x0</code></em>;</span></p></td>
783 <td>Distance (in points) from the left edge of page to the left edge of the left column of
784 cards or labels in the layout.
785 </td>
786 </tr>
787 <tr>
788 <td><p><span class="term"><a
789 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
790 >gdouble</a> <em class="structfield"><code>y0</code></em>;</span></p></td>
791 <td>Distance (in points) from the top edge of page to the top edge of the top row of
792 cards or labels in the layout.
793 </td>
794 </tr>
795 <tr>
796 <td><p><span class="term"><a
797 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
798 >gdouble</a> <em class="structfield"><code>dx</code></em>;</span></p></td>
799 <td>Horizontal pitch of grid in points.  This is the distance from left edge to left edge
800 (not the gap between labels or cards).
801 </td>
802 </tr>
803 <tr>
804 <td><p><span class="term"><a
805 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
806 >gdouble</a> <em class="structfield"><code>dy</code></em>;</span></p></td>
807 <td>Vertical pitch of grid in points.  This is the distance from top edge to top edge
808 (not the gap between labels or cards).
809 </td>
810 </tr>
811 </tbody>
812 </table></div>
813 </div>
814 <hr>
815 <div class="refsect2" title="enum lglTemplateMarkupType">
816 <a name="lglTemplateMarkupType"></a><h3>enum lglTemplateMarkupType</h3>
817 <pre class="programlisting">typedef enum {
818         LGL_TEMPLATE_MARKUP_MARGIN,
819         LGL_TEMPLATE_MARKUP_LINE,
820         LGL_TEMPLATE_MARKUP_CIRCLE,
821         LGL_TEMPLATE_MARKUP_RECT,
822 } lglTemplateMarkupType;
823 </pre>
824 <p>
825 This enumeration defines markup types that are supported by libglabels
826 </p>
827 <div class="variablelist"><table border="0">
828 <col align="left" valign="top">
829 <tbody>
830 <tr>
831 <td><p><a name="LGL-TEMPLATE-MARKUP-MARGIN--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_MARKUP_MARGIN</code></span></p></td>
832 <td>A margin line around perimeter of label or card.
833 </td>
834 </tr>
835 <tr>
836 <td><p><a name="LGL-TEMPLATE-MARKUP-LINE--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_MARKUP_LINE</code></span></p></td>
837 <td>A simple line segment.
838 </td>
839 </tr>
840 <tr>
841 <td><p><a name="LGL-TEMPLATE-MARKUP-CIRCLE--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_MARKUP_CIRCLE</code></span></p></td>
842 <td>A circle.
843 </td>
844 </tr>
845 <tr>
846 <td><p><a name="LGL-TEMPLATE-MARKUP-RECT--CAPS"></a><span class="term"><code class="literal">LGL_TEMPLATE_MARKUP_RECT</code></span></p></td>
847 <td>A rectangle.  Possibly with rounded corners.
848 </td>
849 </tr>
850 </tbody>
851 </table></div>
852 </div>
853 <hr>
854 <div class="refsect2" title="union lglTemplateMarkup">
855 <a name="lglTemplateMarkup"></a><h3>union lglTemplateMarkup</h3>
856 <pre class="programlisting">union lglTemplateMarkup {
857
858         lglTemplateMarkupType   type;
859
860         lglTemplateMarkupMargin margin;
861         lglTemplateMarkupLine   line;
862         lglTemplateMarkupCircle circle;
863         lglTemplateMarkupRect   rect;
864 };
865 </pre>
866 <p>
867 A union of all possible markup structures.  The type of structure is indicated by the type
868 member, which overlays the first field of all other member structures.
869 </p>
870 </div>
871 <hr>
872 <div class="refsect2" title="lglTemplateMarkupMargin">
873 <a name="lglTemplateMarkupMargin"></a><h3>lglTemplateMarkupMargin</h3>
874 <pre class="programlisting">typedef struct {
875         lglTemplateMarkupType  type;  /* Always LGL_TEMPLATE_MARKUP_MARGIN */
876
877         gdouble                size;  /* Margin size */
878 } lglTemplateMarkupMargin;
879 </pre>
880 <p>
881 This structure defines a simple margin markup around the perimeter of a label or card.
882 </p>
883 <div class="variablelist"><table border="0">
884 <col align="left" valign="top">
885 <tbody>
886 <tr>
887 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateMarkupType" title="enum lglTemplateMarkupType">lglTemplateMarkupType</a> <em class="structfield"><code>type</code></em>;</span></p></td>
888 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-MARKUP-MARGIN--CAPS"><span class="type">LGL_TEMPLATE_MARKUP_MARGIN</span></a> for <a class="link" href="libglabels-template.html#lglTemplateMarkupMargin" title="lglTemplateMarkupMargin"><span class="type">lglTemplateMarkupMargin</span></a>.
889 </td>
890 </tr>
891 <tr>
892 <td><p><span class="term"><a
893 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
894 >gdouble</a> <em class="structfield"><code>size</code></em>;</span></p></td>
895 <td>Distance of margin from edge of label or card.
896 </td>
897 </tr>
898 </tbody>
899 </table></div>
900 </div>
901 <hr>
902 <div class="refsect2" title="lglTemplateMarkupLine">
903 <a name="lglTemplateMarkupLine"></a><h3>lglTemplateMarkupLine</h3>
904 <pre class="programlisting">typedef struct {
905         lglTemplateMarkupType  type;   /* Always LGL_TEMPLATE_MARKUP_LINE */
906
907         gdouble                x1, y1; /* 1st endpoint */
908         gdouble                x2, y2; /* 2nd endpoint */
909 } lglTemplateMarkupLine;
910 </pre>
911 <p>
912 This structure defines a simple line segment markup.
913 </p>
914 <div class="variablelist"><table border="0">
915 <col align="left" valign="top">
916 <tbody>
917 <tr>
918 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateMarkupType" title="enum lglTemplateMarkupType">lglTemplateMarkupType</a> <em class="structfield"><code>type</code></em>;</span></p></td>
919 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-MARKUP-LINE--CAPS"><span class="type">LGL_TEMPLATE_MARKUP_LINE</span></a> for <a class="link" href="libglabels-template.html#lglTemplateMarkupLine" title="lglTemplateMarkupLine"><span class="type">lglTemplateMarkupLine</span></a>.
920 </td>
921 </tr>
922 <tr>
923 <td><p><span class="term"><a
924 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
925 >gdouble</a> <em class="structfield"><code>x1</code></em>;</span></p></td>
926 <td>Distance (in points) of first endpoint from left edge of label or card.
927 </td>
928 </tr>
929 <tr>
930 <td><p><span class="term"><a
931 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
932 >gdouble</a> <em class="structfield"><code>y1</code></em>;</span></p></td>
933 <td>Distance (in points) of first endpoint from top edge of label or card.
934 </td>
935 </tr>
936 <tr>
937 <td><p><span class="term"><a
938 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
939 >gdouble</a> <em class="structfield"><code>x2</code></em>;</span></p></td>
940 <td>Distance (in points) of second endpoint from left edge of label or card.
941 </td>
942 </tr>
943 <tr>
944 <td><p><span class="term"><a
945 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
946 >gdouble</a> <em class="structfield"><code>y2</code></em>;</span></p></td>
947 <td>Distance (in points) of second endpoint from top edge of label or card.
948 </td>
949 </tr>
950 </tbody>
951 </table></div>
952 </div>
953 <hr>
954 <div class="refsect2" title="lglTemplateMarkupCircle">
955 <a name="lglTemplateMarkupCircle"></a><h3>lglTemplateMarkupCircle</h3>
956 <pre class="programlisting">typedef struct {
957         lglTemplateMarkupType  type;   /* Always LGL_TEMPLATE_MARKUP_CIRCLE */
958
959         gdouble                x0, y0; /* Center of circle */
960         gdouble                r;      /* Radius of circle */
961 } lglTemplateMarkupCircle;
962 </pre>
963 <p>
964 This structure defines a simple circle markup.
965 </p>
966 <div class="variablelist"><table border="0">
967 <col align="left" valign="top">
968 <tbody>
969 <tr>
970 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateMarkupType" title="enum lglTemplateMarkupType">lglTemplateMarkupType</a> <em class="structfield"><code>type</code></em>;</span></p></td>
971 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-MARKUP-CIRCLE--CAPS"><span class="type">LGL_TEMPLATE_MARKUP_CIRCLE</span></a> for <a class="link" href="libglabels-template.html#lglTemplateMarkupCircle" title="lglTemplateMarkupCircle"><span class="type">lglTemplateMarkupCircle</span></a>.
972 </td>
973 </tr>
974 <tr>
975 <td><p><span class="term"><a
976 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
977 >gdouble</a> <em class="structfield"><code>x0</code></em>;</span></p></td>
978 <td>Distance (in points) of vertex from left edge of label or card.
979 </td>
980 </tr>
981 <tr>
982 <td><p><span class="term"><a
983 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
984 >gdouble</a> <em class="structfield"><code>y0</code></em>;</span></p></td>
985 <td>Distance (in points) of vertex from top edge of label or card.
986 </td>
987 </tr>
988 <tr>
989 <td><p><span class="term"><a
990 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
991 >gdouble</a> <em class="structfield"><code>r</code></em>;</span></p></td>
992 <td>Radius of circle in points.
993 </td>
994 </tr>
995 </tbody>
996 </table></div>
997 </div>
998 <hr>
999 <div class="refsect2" title="lglTemplateMarkupRect">
1000 <a name="lglTemplateMarkupRect"></a><h3>lglTemplateMarkupRect</h3>
1001 <pre class="programlisting">typedef struct {
1002         lglTemplateMarkupType  type;   /* Always LGL_TEMPLATE_MARKUP_RECT */
1003
1004         gdouble                x1, y1; /* Upper left corner */
1005         gdouble                w, h;   /* Width and height. */
1006         gdouble                r;      /* Radius of corners. */
1007 } lglTemplateMarkupRect;
1008 </pre>
1009 <p>
1010 This structure defines a simple rectangle markup.  The rectangle can have rounded corners.
1011 </p>
1012 <div class="variablelist"><table border="0">
1013 <col align="left" valign="top">
1014 <tbody>
1015 <tr>
1016 <td><p><span class="term"><a class="link" href="libglabels-template.html#lglTemplateMarkupType" title="enum lglTemplateMarkupType">lglTemplateMarkupType</a> <em class="structfield"><code>type</code></em>;</span></p></td>
1017 <td>Common field.  Always <a class="link" href="libglabels-template.html#LGL-TEMPLATE-MARKUP-RECT--CAPS"><span class="type">LGL_TEMPLATE_MARKUP_RECT</span></a> for <a class="link" href="libglabels-template.html#lglTemplateMarkupRect" title="lglTemplateMarkupRect"><span class="type">lglTemplateMarkupRect</span></a>.
1018 </td>
1019 </tr>
1020 <tr>
1021 <td><p><span class="term"><a
1022 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1023 >gdouble</a> <em class="structfield"><code>x1</code></em>;</span></p></td>
1024 <td>Distance (in points) of left edge of markup from left edge of label or card.
1025 </td>
1026 </tr>
1027 <tr>
1028 <td><p><span class="term"><a
1029 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1030 >gdouble</a> <em class="structfield"><code>y1</code></em>;</span></p></td>
1031 <td>Distance (in points) of top edge of markup from top edge of label or card.
1032 </td>
1033 </tr>
1034 <tr>
1035 <td><p><span class="term"><a
1036 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1037 >gdouble</a> <em class="structfield"><code>w</code></em>;</span></p></td>
1038 <td>Width of rectangle in points.
1039 </td>
1040 </tr>
1041 <tr>
1042 <td><p><span class="term"><a
1043 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1044 >gdouble</a> <em class="structfield"><code>h</code></em>;</span></p></td>
1045 <td>Height of rectangle in points.
1046 </td>
1047 </tr>
1048 <tr>
1049 <td><p><span class="term"><a
1050 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1051 >gdouble</a> <em class="structfield"><code>r</code></em>;</span></p></td>
1052 <td>Radius of corners in points.  Should be zero for sharp corners.
1053 </td>
1054 </tr>
1055 </tbody>
1056 </table></div>
1057 </div>
1058 <hr>
1059 <div class="refsect2" title="lglTemplateOrigin">
1060 <a name="lglTemplateOrigin"></a><h3>lglTemplateOrigin</h3>
1061 <pre class="programlisting">typedef struct {
1062         gdouble               x, y; /* Label origin relative to upper 
1063                                      * upper left hand corner of paper */
1064 } lglTemplateOrigin;
1065 </pre>
1066 <p>
1067 This structure represents the cartesian coordinates of the origin of a label or card on the page.
1068 The orign is the upper left corner of the extent of the label or card.  These coordinates are
1069 relative to the upper left corner of the page.
1070 </p>
1071 <div class="variablelist"><table border="0">
1072 <col align="left" valign="top">
1073 <tbody>
1074 <tr>
1075 <td><p><span class="term"><a
1076 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1077 >gdouble</a> <em class="structfield"><code>x</code></em>;</span></p></td>
1078 <td>Distance in points from top edge of page.
1079 </td>
1080 </tr>
1081 <tr>
1082 <td><p><span class="term"><a
1083 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1084 >gdouble</a> <em class="structfield"><code>y</code></em>;</span></p></td>
1085 <td>Distance in points from left edge of page.
1086 </td>
1087 </tr>
1088 </tbody>
1089 </table></div>
1090 </div>
1091 <hr>
1092 <div class="refsect2" title="lgl_template_new ()">
1093 <a name="lgl-template-new"></a><h3>lgl_template_new ()</h3>
1094 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       lgl_template_new                    (const <a
1095 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1096 >gchar</a> *brand,
1097                                                          const <a
1098 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1099 >gchar</a> *part,
1100                                                          const <a
1101 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1102 >gchar</a> *description,
1103                                                          const <a
1104 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1105 >gchar</a> *paper_id,
1106                                                          <a
1107 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1108 >gdouble</a> page_width,
1109                                                          <a
1110 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1111 >gdouble</a> page_height);</pre>
1112 <p>
1113 Create a new template structure, with the given top-level attributes.  The
1114 created template will have no initial aliases, categories, or frames
1115 associated with it.  See <a class="link" href="libglabels-template.html#lgl-template-add-alias" title="lgl_template_add_alias ()"><code class="function">lgl_template_add_alias()</code></a>, <a class="link" href="libglabels-template.html#lgl-template-add-category" title="lgl_template_add_category ()"><code class="function">lgl_template_add_category()</code></a>,
1116 and <a class="link" href="libglabels-template.html#lgl-template-add-frame" title="lgl_template_add_frame ()"><code class="function">lgl_template_add_frame()</code></a> to add these.</p>
1117 <p>
1118 </p>
1119 <div class="variablelist"><table border="0">
1120 <col align="left" valign="top">
1121 <tbody>
1122 <tr>
1123 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
1124 <td>        Template brand
1125 </td>
1126 </tr>
1127 <tr>
1128 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
1129 <td>         Template part name/number
1130 </td>
1131 </tr>
1132 <tr>
1133 <td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
1134 <td>  Template descriptions
1135 </td>
1136 </tr>
1137 <tr>
1138 <td><p><span class="term"><em class="parameter"><code>paper_id</code></em> :</span></p></td>
1139 <td>     Page size id
1140 </td>
1141 </tr>
1142 <tr>
1143 <td><p><span class="term"><em class="parameter"><code>page_width</code></em> :</span></p></td>
1144 <td>   Page width in points, set to zero unless paper_id="Other"
1145 </td>
1146 </tr>
1147 <tr>
1148 <td><p><span class="term"><em class="parameter"><code>page_height</code></em> :</span></p></td>
1149 <td>  Page height in points, set to zero unless paper_id="Other"
1150 </td>
1151 </tr>
1152 <tr>
1153 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1154 <td> pointer to a newly allocated <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure.
1155
1156 </td>
1157 </tr>
1158 </tbody>
1159 </table></div>
1160 </div>
1161 <hr>
1162 <div class="refsect2" title="lgl_template_dup ()">
1163 <a name="lgl-template-dup"></a><h3>lgl_template_dup ()</h3>
1164 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       lgl_template_dup                    (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *orig_template);</pre>
1165 <p>
1166 This function duplicates a template structure.</p>
1167 <p>
1168 </p>
1169 <div class="variablelist"><table border="0">
1170 <col align="left" valign="top">
1171 <tbody>
1172 <tr>
1173 <td><p><span class="term"><em class="parameter"><code>orig_template</code></em> :</span></p></td>
1174 <td> Template to duplicate.
1175 </td>
1176 </tr>
1177 <tr>
1178 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1179 <td>  a newly allocated <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure.
1180
1181 </td>
1182 </tr>
1183 </tbody>
1184 </table></div>
1185 </div>
1186 <hr>
1187 <div class="refsect2" title="lgl_template_free ()">
1188 <a name="lgl-template-free"></a><h3>lgl_template_free ()</h3>
1189 <pre class="programlisting">void                lgl_template_free                   (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);</pre>
1190 <p>
1191 This function frees all memory associated with given template structure.</p>
1192 <p>
1193 </p>
1194 <div class="variablelist"><table border="0">
1195 <col align="left" valign="top">
1196 <tbody><tr>
1197 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1198 <td> Template to free.
1199 </td>
1200 </tr></tbody>
1201 </table></div>
1202 </div>
1203 <hr>
1204 <div class="refsect2" title="lgl_template_add_category ()">
1205 <a name="lgl-template-add-category"></a><h3>lgl_template_add_category ()</h3>
1206 <pre class="programlisting">void                lgl_template_add_category           (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1207                                                          const <a
1208 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1209 >gchar</a> *category_id);</pre>
1210 <p>
1211 This function adds the given category ID to a templates category list.</p>
1212 <p>
1213 </p>
1214 <div class="variablelist"><table border="0">
1215 <col align="left" valign="top">
1216 <tbody>
1217 <tr>
1218 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1219 <td>     Pointer to template structure
1220 </td>
1221 </tr>
1222 <tr>
1223 <td><p><span class="term"><em class="parameter"><code>category_id</code></em> :</span></p></td>
1224 <td>  Category ID string
1225 </td>
1226 </tr>
1227 </tbody>
1228 </table></div>
1229 </div>
1230 <hr>
1231 <div class="refsect2" title="lgl_template_add_frame ()">
1232 <a name="lgl-template-add-frame"></a><h3>lgl_template_add_frame ()</h3>
1233 <pre class="programlisting">void                lgl_template_add_frame              (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1234                                                          <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);</pre>
1235 <p>
1236 This function adds the given frame structure to the template.  Once added,
1237 the frame structure belongs to the given template; do not attempt to free
1238 it.
1239 </p>
1240 <p>
1241 Note: Currently glabels only supports a single frame per template.</p>
1242 <p>
1243 </p>
1244 <div class="variablelist"><table border="0">
1245 <col align="left" valign="top">
1246 <tbody>
1247 <tr>
1248 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1249 <td>  Pointer to template structure
1250 </td>
1251 </tr>
1252 <tr>
1253 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1254 <td>     Pointer to frame structure
1255 </td>
1256 </tr>
1257 </tbody>
1258 </table></div>
1259 </div>
1260 <hr>
1261 <div class="refsect2" title="lgl_template_add_alias ()">
1262 <a name="lgl-template-add-alias"></a><h3>lgl_template_add_alias ()</h3>
1263 <pre class="programlisting">void                lgl_template_add_alias              (<a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1264                                                          <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *alias);</pre>
1265 <p>
1266 This function adds the given alias to a templates list of aliases.</p>
1267 <p>
1268 </p>
1269 <div class="variablelist"><table border="0">
1270 <col align="left" valign="top">
1271 <tbody>
1272 <tr>
1273 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1274 <td>  Pointer to template structure
1275 </td>
1276 </tr>
1277 <tr>
1278 <td><p><span class="term"><em class="parameter"><code>alias</code></em> :</span></p></td>
1279 <td>     Alias string
1280 </td>
1281 </tr>
1282 </tbody>
1283 </table></div>
1284 </div>
1285 <hr>
1286 <div class="refsect2" title="lgl_template_get_name ()">
1287 <a name="lgl-template-get-name"></a><h3>lgl_template_get_name ()</h3>
1288 <pre class="programlisting"><a
1289 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1290 >gchar</a> *             lgl_template_get_name               (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template);</pre>
1291 <p>
1292 This function returns the name of the given template.  The name is the concetenation
1293 of the brand and part name/number.</p>
1294 <p>
1295 </p>
1296 <div class="variablelist"><table border="0">
1297 <col align="left" valign="top">
1298 <tbody>
1299 <tr>
1300 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1301 <td>  Pointer to template structure to test
1302 </td>
1303 </tr>
1304 <tr>
1305 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1306 <td>  A pointer to a newly allocated name string.  Should be freed with <a
1307 href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
1308 ><code class="function">g_free()</code></a>.
1309
1310 </td>
1311 </tr>
1312 </tbody>
1313 </table></div>
1314 </div>
1315 <hr>
1316 <div class="refsect2" title="lgl_template_do_templates_match ()">
1317 <a name="lgl-template-do-templates-match"></a><h3>lgl_template_do_templates_match ()</h3>
1318 <pre class="programlisting"><a
1319 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1320 >gboolean</a>            lgl_template_do_templates_match     (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template1,
1321                                                          const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template2);</pre>
1322 <p>
1323 This function tests if the given templates match.  This is a simple test that only tests
1324 the brand and part name/number. It does not test if they are actually identical.</p>
1325 <p>
1326 </p>
1327 <div class="variablelist"><table border="0">
1328 <col align="left" valign="top">
1329 <tbody>
1330 <tr>
1331 <td><p><span class="term"><em class="parameter"><code>template1</code></em> :</span></p></td>
1332 <td>  Pointer to 1st template structure to test
1333 </td>
1334 </tr>
1335 <tr>
1336 <td><p><span class="term"><em class="parameter"><code>template2</code></em> :</span></p></td>
1337 <td>  Pointer to 2nd template structure to test
1338 </td>
1339 </tr>
1340 <tr>
1341 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1342 <td>  TRUE if the two template matche.
1343
1344 </td>
1345 </tr>
1346 </tbody>
1347 </table></div>
1348 </div>
1349 <hr>
1350 <div class="refsect2" title="lgl_template_does_brand_match ()">
1351 <a name="lgl-template-does-brand-match"></a><h3>lgl_template_does_brand_match ()</h3>
1352 <pre class="programlisting"><a
1353 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1354 >gboolean</a>            lgl_template_does_brand_match       (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1355                                                          const <a
1356 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1357 >gchar</a> *brand);</pre>
1358 <p>
1359 This function tests if the brand of the template matches the given brand.</p>
1360 <p>
1361 </p>
1362 <div class="variablelist"><table border="0">
1363 <col align="left" valign="top">
1364 <tbody>
1365 <tr>
1366 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1367 <td>  Pointer to template structure to test
1368 </td>
1369 </tr>
1370 <tr>
1371 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
1372 <td>     Brand string
1373 </td>
1374 </tr>
1375 <tr>
1376 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1377 <td>  TRUE if the template matches the given brand.
1378
1379 </td>
1380 </tr>
1381 </tbody>
1382 </table></div>
1383 </div>
1384 <hr>
1385 <div class="refsect2" title="lgl_template_does_page_size_match ()">
1386 <a name="lgl-template-does-page-size-match"></a><h3>lgl_template_does_page_size_match ()</h3>
1387 <pre class="programlisting"><a
1388 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1389 >gboolean</a>            lgl_template_does_page_size_match   (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1390                                                          const <a
1391 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1392 >gchar</a> *paper_id);</pre>
1393 <p>
1394 This function tests if the page size of the template matches the given ID.</p>
1395 <p>
1396 </p>
1397 <div class="variablelist"><table border="0">
1398 <col align="left" valign="top">
1399 <tbody>
1400 <tr>
1401 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1402 <td>  Pointer to template structure to test
1403 </td>
1404 </tr>
1405 <tr>
1406 <td><p><span class="term"><em class="parameter"><code>paper_id</code></em> :</span></p></td>
1407 <td>  Page size ID string
1408 </td>
1409 </tr>
1410 <tr>
1411 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1412 <td>  TRUE if the template matches the given page size ID.
1413
1414 </td>
1415 </tr>
1416 </tbody>
1417 </table></div>
1418 </div>
1419 <hr>
1420 <div class="refsect2" title="lgl_template_does_category_match ()">
1421 <a name="lgl-template-does-category-match"></a><h3>lgl_template_does_category_match ()</h3>
1422 <pre class="programlisting"><a
1423 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
1424 >gboolean</a>            lgl_template_does_category_match    (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
1425                                                          const <a
1426 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1427 >gchar</a> *category_id);</pre>
1428 <p>
1429 This function tests if the given template belongs to the given category ID.</p>
1430 <p>
1431 </p>
1432 <div class="variablelist"><table border="0">
1433 <col align="left" valign="top">
1434 <tbody>
1435 <tr>
1436 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
1437 <td>     Pointer to template structure to test
1438 </td>
1439 </tr>
1440 <tr>
1441 <td><p><span class="term"><em class="parameter"><code>category_id</code></em> :</span></p></td>
1442 <td>  Category ID string
1443 </td>
1444 </tr>
1445 <tr>
1446 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1447 <td>  TRUE if the template matches the given category ID.
1448
1449 </td>
1450 </tr>
1451 </tbody>
1452 </table></div>
1453 </div>
1454 <hr>
1455 <div class="refsect2" title="lgl_template_alias_new ()">
1456 <a name="lgl-template-alias-new"></a><h3>lgl_template_alias_new ()</h3>
1457 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *  lgl_template_alias_new              (const <a
1458 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1459 >gchar</a> *brand,
1460                                                          const <a
1461 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1462 >gchar</a> *part);</pre>
1463 <p>
1464 Create a new template alias structure, with the given brand and part number.</p>
1465 <p>
1466 </p>
1467 <div class="variablelist"><table border="0">
1468 <col align="left" valign="top">
1469 <tbody>
1470 <tr>
1471 <td><p><span class="term"><em class="parameter"><code>brand</code></em> :</span></p></td>
1472 <td>        Alias brand
1473 </td>
1474 </tr>
1475 <tr>
1476 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
1477 <td>         Alias part name/number
1478 </td>
1479 </tr>
1480 <tr>
1481 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1482 <td> pointer to a newly allocated <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias"><span class="type">lglTemplateAlias</span></a> structure.
1483
1484 </td>
1485 </tr>
1486 </tbody>
1487 </table></div>
1488 </div>
1489 <hr>
1490 <div class="refsect2" title="lgl_template_alias_dup ()">
1491 <a name="lgl-template-alias-dup"></a><h3>lgl_template_alias_dup ()</h3>
1492 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *  lgl_template_alias_dup              (const <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *orig_alias);</pre>
1493 <p>
1494 This function duplicates a template alias structure.</p>
1495 <p>
1496 </p>
1497 <div class="variablelist"><table border="0">
1498 <col align="left" valign="top">
1499 <tbody>
1500 <tr>
1501 <td><p><span class="term"><em class="parameter"><code>orig_alias</code></em> :</span></p></td>
1502 <td> Alias to duplicate.
1503 </td>
1504 </tr>
1505 <tr>
1506 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1507 <td>  a newly allocated <a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias"><span class="type">lglTemplateAlias</span></a> structure.
1508
1509 </td>
1510 </tr>
1511 </tbody>
1512 </table></div>
1513 </div>
1514 <hr>
1515 <div class="refsect2" title="lgl_template_alias_free ()">
1516 <a name="lgl-template-alias-free"></a><h3>lgl_template_alias_free ()</h3>
1517 <pre class="programlisting">void                lgl_template_alias_free             (<a class="link" href="libglabels-template.html#lglTemplateAlias" title="lglTemplateAlias">lglTemplateAlias</a> *alias);</pre>
1518 <p>
1519 This function frees all memory associated with given template alias structure.</p>
1520 <p>
1521 </p>
1522 <div class="variablelist"><table border="0">
1523 <col align="left" valign="top">
1524 <tbody><tr>
1525 <td><p><span class="term"><em class="parameter"><code>alias</code></em> :</span></p></td>
1526 <td> Alias to free.
1527 </td>
1528 </tr></tbody>
1529 </table></div>
1530 </div>
1531 <hr>
1532 <div class="refsect2" title="lgl_template_frame_rect_new ()">
1533 <a name="lgl-template-frame-rect-new"></a><h3>lgl_template_frame_rect_new ()</h3>
1534 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  lgl_template_frame_rect_new         (const <a
1535 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1536 >gchar</a> *id,
1537                                                          <a
1538 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1539 >gdouble</a> w,
1540                                                          <a
1541 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1542 >gdouble</a> h,
1543                                                          <a
1544 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1545 >gdouble</a> r,
1546                                                          <a
1547 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1548 >gdouble</a> x_waste,
1549                                                          <a
1550 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1551 >gdouble</a> y_waste);</pre>
1552 <p>
1553 This function creates a new template frame for a rectangular label or card.</p>
1554 <p>
1555 </p>
1556 <div class="variablelist"><table border="0">
1557 <col align="left" valign="top">
1558 <tbody>
1559 <tr>
1560 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1561 <td>      ID of frame.  (This should currently always be "0").
1562 </td>
1563 </tr>
1564 <tr>
1565 <td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
1566 <td>       width of frame in points.
1567 </td>
1568 </tr>
1569 <tr>
1570 <td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
1571 <td>       height of frame in points.
1572 </td>
1573 </tr>
1574 <tr>
1575 <td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
1576 <td>       radius of rounded corners in points.  (Should be 0 for square corners.)
1577 </td>
1578 </tr>
1579 <tr>
1580 <td><p><span class="term"><em class="parameter"><code>x_waste</code></em> :</span></p></td>
1581 <td> Amount of overprint to allow in the horizontal direction.
1582 </td>
1583 </tr>
1584 <tr>
1585 <td><p><span class="term"><em class="parameter"><code>y_waste</code></em> :</span></p></td>
1586 <td> Amount of overprint to allow in the vertical direction.
1587 </td>
1588 </tr>
1589 <tr>
1590 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1591 <td> Pointer to newly allocated <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure.
1592
1593 </td>
1594 </tr>
1595 </tbody>
1596 </table></div>
1597 </div>
1598 <hr>
1599 <div class="refsect2" title="lgl_template_frame_round_new ()">
1600 <a name="lgl-template-frame-round-new"></a><h3>lgl_template_frame_round_new ()</h3>
1601 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  lgl_template_frame_round_new        (const <a
1602 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1603 >gchar</a> *id,
1604                                                          <a
1605 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1606 >gdouble</a> r,
1607                                                          <a
1608 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1609 >gdouble</a> waste);</pre>
1610 <p>
1611 This function creates a new template frame for a round label.</p>
1612 <p>
1613 </p>
1614 <div class="variablelist"><table border="0">
1615 <col align="left" valign="top">
1616 <tbody>
1617 <tr>
1618 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1619 <td>      ID of frame.  (This should currently always be "0").
1620 </td>
1621 </tr>
1622 <tr>
1623 <td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
1624 <td>       radius of label in points.
1625 </td>
1626 </tr>
1627 <tr>
1628 <td><p><span class="term"><em class="parameter"><code>waste</code></em> :</span></p></td>
1629 <td>   Amount of overprint to allow.
1630 </td>
1631 </tr>
1632 <tr>
1633 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1634 <td> Pointer to newly allocated <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure.
1635
1636 </td>
1637 </tr>
1638 </tbody>
1639 </table></div>
1640 </div>
1641 <hr>
1642 <div class="refsect2" title="lgl_template_frame_cd_new ()">
1643 <a name="lgl-template-frame-cd-new"></a><h3>lgl_template_frame_cd_new ()</h3>
1644 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  lgl_template_frame_cd_new           (const <a
1645 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
1646 >gchar</a> *id,
1647                                                          <a
1648 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1649 >gdouble</a> r1,
1650                                                          <a
1651 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1652 >gdouble</a> r2,
1653                                                          <a
1654 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1655 >gdouble</a> w,
1656                                                          <a
1657 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1658 >gdouble</a> h,
1659                                                          <a
1660 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1661 >gdouble</a> waste);</pre>
1662 <p>
1663 This function creates a new template frame for a CD/DVD label.</p>
1664 <p>
1665 </p>
1666 <div class="variablelist"><table border="0">
1667 <col align="left" valign="top">
1668 <tbody>
1669 <tr>
1670 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
1671 <td>      ID of frame.  (This should currently always be "0").
1672 </td>
1673 </tr>
1674 <tr>
1675 <td><p><span class="term"><em class="parameter"><code>r1</code></em> :</span></p></td>
1676 <td>      outer radius of label in points.
1677 </td>
1678 </tr>
1679 <tr>
1680 <td><p><span class="term"><em class="parameter"><code>r2</code></em> :</span></p></td>
1681 <td>      radius of center hole in points.
1682 </td>
1683 </tr>
1684 <tr>
1685 <td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
1686 <td>       clip width of frame in points for business card CDs.  Should be 0 for no clipping.
1687 </td>
1688 </tr>
1689 <tr>
1690 <td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
1691 <td>       clip height of frame in points for business card CDs.  Should be 0 for no clipping.
1692 </td>
1693 </tr>
1694 <tr>
1695 <td><p><span class="term"><em class="parameter"><code>waste</code></em> :</span></p></td>
1696 <td>   Amount of overprint to allow.
1697 </td>
1698 </tr>
1699 <tr>
1700 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1701 <td> Pointer to newly allocated <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure.
1702
1703 </td>
1704 </tr>
1705 </tbody>
1706 </table></div>
1707 </div>
1708 <hr>
1709 <div class="refsect2" title="lgl_template_frame_dup ()">
1710 <a name="lgl-template-frame-dup"></a><h3>lgl_template_frame_dup ()</h3>
1711 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *  lgl_template_frame_dup              (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *orig_frame);</pre>
1712 <p>
1713 This function duplicates a template frame structure.</p>
1714 <p>
1715 </p>
1716 <div class="variablelist"><table border="0">
1717 <col align="left" valign="top">
1718 <tbody>
1719 <tr>
1720 <td><p><span class="term"><em class="parameter"><code>orig_frame</code></em> :</span></p></td>
1721 <td> Frame to duplicate.
1722 </td>
1723 </tr>
1724 <tr>
1725 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1726 <td>  a newly allocated <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure.
1727
1728 </td>
1729 </tr>
1730 </tbody>
1731 </table></div>
1732 </div>
1733 <hr>
1734 <div class="refsect2" title="lgl_template_frame_free ()">
1735 <a name="lgl-template-frame-free"></a><h3>lgl_template_frame_free ()</h3>
1736 <pre class="programlisting">void                lgl_template_frame_free             (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);</pre>
1737 <p>
1738 This function frees all memory associated with given template frame structure.</p>
1739 <p>
1740 </p>
1741 <div class="variablelist"><table border="0">
1742 <col align="left" valign="top">
1743 <tbody><tr>
1744 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1745 <td> Frame to free.
1746 </td>
1747 </tr></tbody>
1748 </table></div>
1749 </div>
1750 <hr>
1751 <div class="refsect2" title="lgl_template_frame_add_layout ()">
1752 <a name="lgl-template-frame-add-layout"></a><h3>lgl_template_frame_add_layout ()</h3>
1753 <pre class="programlisting">void                lgl_template_frame_add_layout       (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
1754                                                          <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *layout);</pre>
1755 <p>
1756 This function adds a layout structure to the given template frame.</p>
1757 <p>
1758 </p>
1759 <div class="variablelist"><table border="0">
1760 <col align="left" valign="top">
1761 <tbody>
1762 <tr>
1763 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1764 <td>  Pointer to template frame to add layout to.
1765 </td>
1766 </tr>
1767 <tr>
1768 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
1769 <td> Pointer to layout structure to add to frame.
1770 </td>
1771 </tr>
1772 </tbody>
1773 </table></div>
1774 </div>
1775 <hr>
1776 <div class="refsect2" title="lgl_template_frame_add_markup ()">
1777 <a name="lgl-template-frame-add-markup"></a><h3>lgl_template_frame_add_markup ()</h3>
1778 <pre class="programlisting">void                lgl_template_frame_add_markup       (<a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
1779                                                          <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *markup);</pre>
1780 <p>
1781 This function adds a markup structure to the given template frame.</p>
1782 <p>
1783 </p>
1784 <div class="variablelist"><table border="0">
1785 <col align="left" valign="top">
1786 <tbody>
1787 <tr>
1788 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1789 <td>  Pointer to template frame to add markup to.
1790 </td>
1791 </tr>
1792 <tr>
1793 <td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
1794 <td> Pointer to markup structure to add to frame.
1795 </td>
1796 </tr>
1797 </tbody>
1798 </table></div>
1799 </div>
1800 <hr>
1801 <div class="refsect2" title="lgl_template_frame_get_size ()">
1802 <a name="lgl-template-frame-get-size"></a><h3>lgl_template_frame_get_size ()</h3>
1803 <pre class="programlisting">void                lgl_template_frame_get_size         (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame,
1804                                                          <a
1805 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1806 >gdouble</a> *w,
1807                                                          <a
1808 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1809 >gdouble</a> *h);</pre>
1810 <p>
1811 Get size (width and height) of given <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> in points.</p>
1812 <p>
1813 </p>
1814 <div class="variablelist"><table border="0">
1815 <col align="left" valign="top">
1816 <tbody>
1817 <tr>
1818 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1819 <td> <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure to query
1820 </td>
1821 </tr>
1822 <tr>
1823 <td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
1824 <td> pointer to location to receive width of frame
1825 </td>
1826 </tr>
1827 <tr>
1828 <td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
1829 <td> pointer to location to receive height of frame
1830 </td>
1831 </tr>
1832 </tbody>
1833 </table></div>
1834 </div>
1835 <hr>
1836 <div class="refsect2" title="lgl_template_frame_get_n_labels ()">
1837 <a name="lgl-template-frame-get-n-labels"></a><h3>lgl_template_frame_get_n_labels ()</h3>
1838 <pre class="programlisting"><a
1839 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
1840 >gint</a>                lgl_template_frame_get_n_labels     (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);</pre>
1841 <p>
1842 Get total number of labels per sheet corresponding to the given frame.</p>
1843 <p>
1844 </p>
1845 <div class="variablelist"><table border="0">
1846 <col align="left" valign="top">
1847 <tbody>
1848 <tr>
1849 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1850 <td> <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure to query
1851 </td>
1852 </tr>
1853 <tr>
1854 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1855 <td> number of labels per sheet.
1856
1857 </td>
1858 </tr>
1859 </tbody>
1860 </table></div>
1861 </div>
1862 <hr>
1863 <div class="refsect2" title="lgl_template_frame_get_origins ()">
1864 <a name="lgl-template-frame-get-origins"></a><h3>lgl_template_frame_get_origins ()</h3>
1865 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateOrigin" title="lglTemplateOrigin">lglTemplateOrigin</a> * lgl_template_frame_get_origins      (const <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame">lglTemplateFrame</a> *frame);</pre>
1866 <p>
1867 Get an array of label origins for the given frame.  These origins represent the
1868 upper left hand corner of each label on a page corresponding to the given frame.
1869 The origins will be ordered geometrically left to right and then top to bottom.
1870 The array should be freed using <a
1871 href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
1872 ><code class="function">g_free()</code></a>.</p>
1873 <p>
1874 </p>
1875 <div class="variablelist"><table border="0">
1876 <col align="left" valign="top">
1877 <tbody>
1878 <tr>
1879 <td><p><span class="term"><em class="parameter"><code>frame</code></em> :</span></p></td>
1880 <td> <a class="link" href="libglabels-template.html#lglTemplateFrame" title="union lglTemplateFrame"><span class="type">lglTemplateFrame</span></a> structure to query
1881 </td>
1882 </tr>
1883 <tr>
1884 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1885 <td> A newly allocated array of <a class="link" href="libglabels-template.html#lglTemplateOrigin" title="lglTemplateOrigin"><span class="type">lglTemplateOrigin</span></a> structures.
1886
1887 </td>
1888 </tr>
1889 </tbody>
1890 </table></div>
1891 </div>
1892 <hr>
1893 <div class="refsect2" title="lgl_template_layout_new ()">
1894 <a name="lgl-template-layout-new"></a><h3>lgl_template_layout_new ()</h3>
1895 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> * lgl_template_layout_new             (<a
1896 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
1897 >gint</a> nx,
1898                                                          <a
1899 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
1900 >gint</a> ny,
1901                                                          <a
1902 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1903 >gdouble</a> x0,
1904                                                          <a
1905 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1906 >gdouble</a> y0,
1907                                                          <a
1908 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1909 >gdouble</a> dx,
1910                                                          <a
1911 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
1912 >gdouble</a> dy);</pre>
1913 <p>
1914 This function creates a new layout structure with the given parameters.</p>
1915 <p>
1916 </p>
1917 <div class="variablelist"><table border="0">
1918 <col align="left" valign="top">
1919 <tbody>
1920 <tr>
1921 <td><p><span class="term"><em class="parameter"><code>nx</code></em> :</span></p></td>
1922 <td>  Number of labels across.
1923 </td>
1924 </tr>
1925 <tr>
1926 <td><p><span class="term"><em class="parameter"><code>ny</code></em> :</span></p></td>
1927 <td>  Number of labels down.
1928 </td>
1929 </tr>
1930 <tr>
1931 <td><p><span class="term"><em class="parameter"><code>x0</code></em> :</span></p></td>
1932 <td>  X coordinate of the top-left corner of the top-left label in the layout in points.
1933 </td>
1934 </tr>
1935 <tr>
1936 <td><p><span class="term"><em class="parameter"><code>y0</code></em> :</span></p></td>
1937 <td>  Y coordinate of the top-left corner of the top-left label in the layout in points.
1938 </td>
1939 </tr>
1940 <tr>
1941 <td><p><span class="term"><em class="parameter"><code>dx</code></em> :</span></p></td>
1942 <td>  Horizontal pitch in points.  This is the distance from left-edge to left-edge.
1943 </td>
1944 </tr>
1945 <tr>
1946 <td><p><span class="term"><em class="parameter"><code>dy</code></em> :</span></p></td>
1947 <td>  Vertical pitch in points.  This is the distance from top-edge to top-edge.
1948 </td>
1949 </tr>
1950 <tr>
1951 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1952 <td> a newly allocated <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout"><span class="type">lglTemplateLayout</span></a> structure.
1953
1954 </td>
1955 </tr>
1956 </tbody>
1957 </table></div>
1958 </div>
1959 <hr>
1960 <div class="refsect2" title="lgl_template_layout_dup ()">
1961 <a name="lgl-template-layout-dup"></a><h3>lgl_template_layout_dup ()</h3>
1962 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> * lgl_template_layout_dup             (const <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *orig_layout);</pre>
1963 <p>
1964 This function duplicates a template layout structure.</p>
1965 <p>
1966 </p>
1967 <div class="variablelist"><table border="0">
1968 <col align="left" valign="top">
1969 <tbody>
1970 <tr>
1971 <td><p><span class="term"><em class="parameter"><code>orig_layout</code></em> :</span></p></td>
1972 <td> Layout to duplicate.
1973 </td>
1974 </tr>
1975 <tr>
1976 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1977 <td>  a newly allocated <a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout"><span class="type">lglTemplateLayout</span></a> structure.
1978
1979 </td>
1980 </tr>
1981 </tbody>
1982 </table></div>
1983 </div>
1984 <hr>
1985 <div class="refsect2" title="lgl_template_layout_free ()">
1986 <a name="lgl-template-layout-free"></a><h3>lgl_template_layout_free ()</h3>
1987 <pre class="programlisting">void                lgl_template_layout_free            (<a class="link" href="libglabels-template.html#lglTemplateLayout" title="lglTemplateLayout">lglTemplateLayout</a> *layout);</pre>
1988 <p>
1989 This function frees all memory associated with given template layout structure.</p>
1990 <p>
1991 </p>
1992 <div class="variablelist"><table border="0">
1993 <col align="left" valign="top">
1994 <tbody><tr>
1995 <td><p><span class="term"><em class="parameter"><code>layout</code></em> :</span></p></td>
1996 <td> Layout to free.
1997 </td>
1998 </tr></tbody>
1999 </table></div>
2000 </div>
2001 <hr>
2002 <div class="refsect2" title="lgl_template_markup_margin_new ()">
2003 <a name="lgl-template-markup-margin-new"></a><h3>lgl_template_markup_margin_new ()</h3>
2004 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * lgl_template_markup_margin_new      (<a
2005 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2006 >gdouble</a> size);</pre>
2007 <p>
2008 This function creates a new margin markup structure.</p>
2009 <p>
2010 </p>
2011 <div class="variablelist"><table border="0">
2012 <col align="left" valign="top">
2013 <tbody>
2014 <tr>
2015 <td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
2016 <td> margin size in points.
2017 </td>
2018 </tr>
2019 <tr>
2020 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2021 <td> a newly allocated <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> structure.
2022
2023 </td>
2024 </tr>
2025 </tbody>
2026 </table></div>
2027 </div>
2028 <hr>
2029 <div class="refsect2" title="lgl_template_markup_line_new ()">
2030 <a name="lgl-template-markup-line-new"></a><h3>lgl_template_markup_line_new ()</h3>
2031 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * lgl_template_markup_line_new        (<a
2032 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2033 >gdouble</a> x1,
2034                                                          <a
2035 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2036 >gdouble</a> y1,
2037                                                          <a
2038 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2039 >gdouble</a> x2,
2040                                                          <a
2041 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2042 >gdouble</a> y2);</pre>
2043 <p>
2044 This function creates a new line markup structure.</p>
2045 <p>
2046 </p>
2047 <div class="variablelist"><table border="0">
2048 <col align="left" valign="top">
2049 <tbody>
2050 <tr>
2051 <td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
2052 <td> x coordinate of first endpoint.
2053 </td>
2054 </tr>
2055 <tr>
2056 <td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
2057 <td> y coordinate of first endpoint.
2058 </td>
2059 </tr>
2060 <tr>
2061 <td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
2062 <td> x coordinate of second endpoint.
2063 </td>
2064 </tr>
2065 <tr>
2066 <td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
2067 <td> y coordinate of second endpoint.
2068 </td>
2069 </tr>
2070 <tr>
2071 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2072 <td> a newly allocated <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> structure.
2073
2074 </td>
2075 </tr>
2076 </tbody>
2077 </table></div>
2078 </div>
2079 <hr>
2080 <div class="refsect2" title="lgl_template_markup_circle_new ()">
2081 <a name="lgl-template-markup-circle-new"></a><h3>lgl_template_markup_circle_new ()</h3>
2082 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * lgl_template_markup_circle_new      (<a
2083 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2084 >gdouble</a> x0,
2085                                                          <a
2086 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2087 >gdouble</a> y0,
2088                                                          <a
2089 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2090 >gdouble</a> r);</pre>
2091 <p>
2092 This function creates a new circle markup structure.</p>
2093 <p>
2094 </p>
2095 <div class="variablelist"><table border="0">
2096 <col align="left" valign="top">
2097 <tbody>
2098 <tr>
2099 <td><p><span class="term"><em class="parameter"><code>x0</code></em> :</span></p></td>
2100 <td> x coordinate of center of circle.
2101 </td>
2102 </tr>
2103 <tr>
2104 <td><p><span class="term"><em class="parameter"><code>y0</code></em> :</span></p></td>
2105 <td> y coordinate of center of circle.
2106 </td>
2107 </tr>
2108 <tr>
2109 <td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
2110 <td>  radius of circle.
2111 </td>
2112 </tr>
2113 <tr>
2114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2115 <td> a newly allocated <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> structure.
2116
2117 </td>
2118 </tr>
2119 </tbody>
2120 </table></div>
2121 </div>
2122 <hr>
2123 <div class="refsect2" title="lgl_template_markup_rect_new ()">
2124 <a name="lgl-template-markup-rect-new"></a><h3>lgl_template_markup_rect_new ()</h3>
2125 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * lgl_template_markup_rect_new        (<a
2126 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2127 >gdouble</a> x1,
2128                                                          <a
2129 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2130 >gdouble</a> y1,
2131                                                          <a
2132 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2133 >gdouble</a> w,
2134                                                          <a
2135 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2136 >gdouble</a> h,
2137                                                          <a
2138 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
2139 >gdouble</a> r);</pre>
2140 <p>
2141 This function creates a new rectangle markup structure.</p>
2142 <p>
2143 </p>
2144 <div class="variablelist"><table border="0">
2145 <col align="left" valign="top">
2146 <tbody>
2147 <tr>
2148 <td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
2149 <td> x coordinate of top-left corner of rectangle.
2150 </td>
2151 </tr>
2152 <tr>
2153 <td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
2154 <td> y coordinate of top-left corner of rectangle.
2155 </td>
2156 </tr>
2157 <tr>
2158 <td><p><span class="term"><em class="parameter"><code>w</code></em> :</span></p></td>
2159 <td>  width of rectangle.
2160 </td>
2161 </tr>
2162 <tr>
2163 <td><p><span class="term"><em class="parameter"><code>h</code></em> :</span></p></td>
2164 <td>  height of rectangle.
2165 </td>
2166 </tr>
2167 <tr>
2168 <td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
2169 <td>  radius of rounded corner.
2170 </td>
2171 </tr>
2172 <tr>
2173 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2174 <td> a newly allocated <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> structure.
2175
2176 </td>
2177 </tr>
2178 </tbody>
2179 </table></div>
2180 </div>
2181 <hr>
2182 <div class="refsect2" title="lgl_template_markup_dup ()">
2183 <a name="lgl-template-markup-dup"></a><h3>lgl_template_markup_dup ()</h3>
2184 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> * lgl_template_markup_dup             (const <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *orig_markup);</pre>
2185 <p>
2186 This function duplicates a template markup structure.</p>
2187 <p>
2188 </p>
2189 <div class="variablelist"><table border="0">
2190 <col align="left" valign="top">
2191 <tbody>
2192 <tr>
2193 <td><p><span class="term"><em class="parameter"><code>orig_markup</code></em> :</span></p></td>
2194 <td> Markup to duplicate.
2195 </td>
2196 </tr>
2197 <tr>
2198 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2199 <td>  a newly allocated <a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup"><span class="type">lglTemplateMarkup</span></a> structure.
2200
2201 </td>
2202 </tr>
2203 </tbody>
2204 </table></div>
2205 </div>
2206 <hr>
2207 <div class="refsect2" title="lgl_template_markup_free ()">
2208 <a name="lgl-template-markup-free"></a><h3>lgl_template_markup_free ()</h3>
2209 <pre class="programlisting">void                lgl_template_markup_free            (<a class="link" href="libglabels-template.html#lglTemplateMarkup" title="union lglTemplateMarkup">lglTemplateMarkup</a> *markup);</pre>
2210 <p>
2211 This function frees all memory associated with given template markup structure.</p>
2212 <p>
2213 </p>
2214 <div class="variablelist"><table border="0">
2215 <col align="left" valign="top">
2216 <tbody><tr>
2217 <td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
2218 <td> Markup to free.
2219 </td>
2220 </tr></tbody>
2221 </table></div>
2222 </div>
2223 </div>
2224 </div>
2225 <div class="footer">
2226 <hr>
2227           Generated by GTK-Doc V1.11</div>
2228 </body>
2229 </html>