File: libpaps_8h.html

package info (click to toggle)
paps 0.6.8-7.3
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 2,244 kB
  • sloc: sh: 9,020; ansic: 1,681; makefile: 78
file content (342 lines) | stat: -rw-r--r-- 16,980 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libpaps: src/libpaps.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="dir_961101405ef5bfdb40c985f8da0fa437.html">src</a></div>
<h1>libpaps.h File Reference</h1>Interface for converting pango layouts into postscript. <a href="#_details">More...</a>
<p>
<code>#include &lt;glib.h&gt;</code><br>
<code>#include &lt;pango/pango.h&gt;</code><br>

<p>
<a href="libpaps_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#4ddc548ab818eb9fe351def79d48ced6">paps_new</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#0212735249a4b8d88f0fd0e1e06e46ee">paps_free</a> (<a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *paps)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#5892014cb4542c7b9d3d468c106f966c">paps_set_scale</a> (<a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *paps, gdouble scale_x, gdouble scale_y)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">PangoContext *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#3eb383e3f29a4ed8545907c2957db9b0">paps_get_pango_context</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">gchar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#ee8da2e0bfae73ca0e8a9046384d838d">paps_get_postscript_header_strdup</a> (<a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *paps)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">gchar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#50206ea82dafae0aabb642a9801a02af">paps_layout_to_postscript_strdup</a> (<a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *paps, double pos_x, double pos_y, PangoLayout *layout)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">gchar *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#9f692485f31a541f175e7a3c28ea7faf">paps_layout_line_to_postscript_strdup</a> (<a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *paps, double pos_x, double pos_y, PangoLayoutLine *layout_line)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="libpaps_8h.html#fcf44cad7f299c059dc132fed567beca">paps_postscript_points_to_pango</a> (double points)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for converting pango layouts into postscript. 
<p>
The library is used by first creating a paps object through <a class="el" href="libpaps_8h.html#4ddc548ab818eb9fe351def79d48ced6">paps_new()</a>. The paps object is then used to generate PostScript for one or more pango layouts through <a class="el" href="libpaps_8h.html#50206ea82dafae0aabb642a9801a02af">paps_layout_to_postscript_strdup()</a> or <a class="el" href="libpaps_8h.html#9f692485f31a541f175e7a3c28ea7faf">paps_layout_line_to_postscript_strdup()</a>. Once all the layouts have been processed, the system may generate the PostScript header through <a class="el" href="libpaps_8h.html#ee8da2e0bfae73ca0e8a9046384d838d">paps_get_postscript_header_strdup()</a>. It is the responsibility of the caller to place the PostScript header in front of the renderings of the pango layouts.<p>
The PostScript of the rendered layouts is relocatable in all sense so any postscript operators may be used to change their colors, transformations etc. <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="b6cb108cff4a0306a2786a4b748f81ac"></a><!-- doxytag: member="libpaps.h::paps_t" ref="b6cb108cff4a0306a2786a4b748f81ac" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void <a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The paps handle taht is used in all interactions with the paps library. 
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="0212735249a4b8d88f0fd0e1e06e46ee"></a><!-- doxytag: member="libpaps.h::paps_free" ref="0212735249a4b8d88f0fd0e1e06e46ee" args="(paps_t *paps)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void paps_free           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td>
          <td class="paramname"> <em>paps</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Delete the paps object and free any allocated memory associated with it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>paps</em>&nbsp;</td><td></td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="3eb383e3f29a4ed8545907c2957db9b0"></a><!-- doxytag: member="libpaps.h::paps_get_pango_context" ref="3eb383e3f29a4ed8545907c2957db9b0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PangoContext* paps_get_pango_context           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
libpaps may currently be used only with a PangoContext that it is creating. The context returned may of course be changed though by any routines related to a PangoContext.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div><p>
<a class="anchor" name="ee8da2e0bfae73ca0e8a9046384d838d"></a><!-- doxytag: member="libpaps.h::paps_get_postscript_header_strdup" ref="ee8da2e0bfae73ca0e8a9046384d838d" args="(paps_t *paps)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gchar* paps_get_postscript_header_strdup           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td>
          <td class="paramname"> <em>paps</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<a class="el" href="libpaps_8h.html#ee8da2e0bfae73ca0e8a9046384d838d">paps_get_postscript_header_strdup()</a> returns the header and the font definitions related to the glyphs being used. This routine must only be called after the processing of all the strings is over.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>paps</em>&nbsp;</td><td>Paps object</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A newly allocated string containing the postscript prologue needed for the postscript strings created by libpaps. </dd></dl>

</div>
</div><p>
<a class="anchor" name="9f692485f31a541f175e7a3c28ea7faf"></a><!-- doxytag: member="libpaps.h::paps_layout_line_to_postscript_strdup" ref="9f692485f31a541f175e7a3c28ea7faf" args="(paps_t *paps, double pos_x, double pos_y, PangoLayoutLine *layout_line)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gchar* paps_layout_line_to_postscript_strdup           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td>
          <td class="paramname"> <em>paps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>pos_x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>pos_y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PangoLayoutLine *&nbsp;</td>
          <td class="paramname"> <em>layout_line</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create postscript related to a single PangoLayout line at position pos_x, pos_y (postscript coordinates). The related font definitions are stored internally and will be returned when doing paps_get_postscript_header_strdup.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>paps</em>&nbsp;</td><td>Paps object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pos_x</em>&nbsp;</td><td>x-position </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pos_y</em>&nbsp;</td><td>y-position </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layout_line</em>&nbsp;</td><td>Layout line to render</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div><p>
<a class="anchor" name="50206ea82dafae0aabb642a9801a02af"></a><!-- doxytag: member="libpaps.h::paps_layout_to_postscript_strdup" ref="50206ea82dafae0aabb642a9801a02af" args="(paps_t *paps, double pos_x, double pos_y, PangoLayout *layout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gchar* paps_layout_to_postscript_strdup           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td>
          <td class="paramname"> <em>paps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>pos_x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>pos_y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PangoLayout *&nbsp;</td>
          <td class="paramname"> <em>layout</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create postscript related to a PangoLayout at position pos_x, pos_y (postscript coordinates). The related font definitions are stored internally and will be returned when doing paps_get_postscript_header_strdup.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>paps</em>&nbsp;</td><td>Paps object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pos_x</em>&nbsp;</td><td>x-position </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pos_y</em>&nbsp;</td><td>y-position </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>layout</em>&nbsp;</td><td>Layout to render</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div><p>
<a class="anchor" name="4ddc548ab818eb9fe351def79d48ced6"></a><!-- doxytag: member="libpaps.h::paps_new" ref="4ddc548ab818eb9fe351def79d48ced6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a>* paps_new           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new paps object that may subsequently be used for generating postscript strings.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div><p>
<a class="anchor" name="fcf44cad7f299c059dc132fed567beca"></a><!-- doxytag: member="libpaps.h::paps_postscript_points_to_pango" ref="fcf44cad7f299c059dc132fed567beca" args="(double points)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double paps_postscript_points_to_pango           </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>points</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Utility function that translates from postscript points to pango units.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>points</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div><p>
<a class="anchor" name="5892014cb4542c7b9d3d468c106f966c"></a><!-- doxytag: member="libpaps.h::paps_set_scale" ref="5892014cb4542c7b9d3d468c106f966c" args="(paps_t *paps, gdouble scale_x, gdouble scale_y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void paps_set_scale           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="libpaps_8h.html#b6cb108cff4a0306a2786a4b748f81ac">paps_t</a> *&nbsp;</td>
          <td class="paramname"> <em>paps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gdouble&nbsp;</td>
          <td class="paramname"> <em>scale_x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gdouble&nbsp;</td>
          <td class="paramname"> <em>scale_y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the scales for characters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>paps</em>&nbsp;</td><td>Paps object </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>scale_x</em>&nbsp;</td><td>x-coordinate scale </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>scale_y</em>&nbsp;</td><td>y-coordinate scale </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Nov 28 23:28:29 2006 for libpaps by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>