summaryrefslogtreecommitdiff
path: root/doc/gutenprint/html/list_8h.html
blob: 26e7fc540b1d970ac4ef66028f78e91d91b6400f (plain)
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
<!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>libgutenprint API Reference: include/gutenprint/list.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.3-20050530 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">gutenprint</a></div>
<h1>list.h File Reference</h1>Generic list functions. <a href="#_details">More...</a>
<p>
<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 stp_list_item&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga0">stp_list_item_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list item opaque data type.  <a href="group__list.html#ga0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef stp_list&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga1">stp_list_t</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The list opaque data type.  <a href="group__list.html#ga1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga2">stp_node_freefunc</a> )(void *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A callback function to free the data a node contains.  <a href="group__list.html#ga2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga3">stp_node_copyfunc</a> )(const void *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A callback function to copy the data a node contains.  <a href="group__list.html#ga3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef const char *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga4">stp_node_namefunc</a> )(const void *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A callback function to get the name of a node.  <a href="group__list.html#ga4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga5">stp_node_sortfunc</a> )(const void *, const void *)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A callback function to compare two nodes.  <a href="group__list.html#ga5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga6">stp_list_node_free_data</a> (void *item)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Free node data allocated with stp_malloc.  <a href="group__list.html#ga6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga1">stp_list_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga7">stp_list_create</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new list object.  <a href="group__list.html#ga7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga1">stp_list_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga8">stp_list_copy</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy and allocate a list object.  <a href="group__list.html#ga8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga9">stp_list_destroy</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a list object.  <a href="group__list.html#ga9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga10">stp_list_get_start</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find the first item in a list.  <a href="group__list.html#ga10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga11">stp_list_get_end</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find the last item in a list.  <a href="group__list.html#ga11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga12">stp_list_get_item_by_index</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list, int idx)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find an item in a list by its index.  <a href="group__list.html#ga12"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga13">stp_list_get_item_by_name</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list, const char *name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find an item in a list by its name.  <a href="group__list.html#ga13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga14">stp_list_get_item_by_long_name</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list, const char *long_name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find an item in a list by its long name.  <a href="group__list.html#ga14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga15">stp_list_get_length</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the length of a list.  <a href="group__list.html#ga15"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga16">stp_list_set_freefunc</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga2">stp_node_freefunc</a> freefunc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a list node free function.  <a href="group__list.html#ga16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga2">stp_node_freefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga17">stp_list_get_freefunc</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a list node free function.  <a href="group__list.html#ga17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga18">stp_list_set_copyfunc</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga3">stp_node_copyfunc</a> copyfunc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a list node copy function.  <a href="group__list.html#ga18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga3">stp_node_copyfunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga19">stp_list_get_copyfunc</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a list node copy function.  <a href="group__list.html#ga19"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga20">stp_list_set_namefunc</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga4">stp_node_namefunc</a> namefunc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a list node name function.  <a href="group__list.html#ga20"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga4">stp_node_namefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga21">stp_list_get_namefunc</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a list node name function.  <a href="group__list.html#ga21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga22">stp_list_set_long_namefunc</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga4">stp_node_namefunc</a> long_namefunc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a list node long name function.  <a href="group__list.html#ga22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga4">stp_node_namefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga23">stp_list_get_long_namefunc</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a list node long name function.  <a href="group__list.html#ga23"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga24">stp_list_set_sortfunc</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga5">stp_node_sortfunc</a> sortfunc)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a list node sort function.  <a href="group__list.html#ga24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga5">stp_node_sortfunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga25">stp_list_get_sortfunc</a> (const <a class="el" href="group__list.html#ga1">stp_list_t</a> *list)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a list node sort function.  <a href="group__list.html#ga25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga26">stp_list_item_create</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga0">stp_list_item_t</a> *next, const void *data)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new list item.  <a href="group__list.html#ga26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga27">stp_list_item_destroy</a> (<a class="el" href="group__list.html#ga1">stp_list_t</a> *list, <a class="el" href="group__list.html#ga0">stp_list_item_t</a> *item)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a list item.  <a href="group__list.html#ga27"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga28">stp_list_item_prev</a> (const <a class="el" href="group__list.html#ga0">stp_list_item_t</a> *item)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the previous item in the list.  <a href="group__list.html#ga28"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ga0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga29">stp_list_item_next</a> (const <a class="el" href="group__list.html#ga0">stp_list_item_t</a> *item)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the next item in the list.  <a href="group__list.html#ga29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga30">stp_list_item_get_data</a> (const <a class="el" href="group__list.html#ga0">stp_list_item_t</a> *item)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the data associated with a list item.  <a href="group__list.html#ga30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga31">stp_list_item_set_data</a> (<a class="el" href="group__list.html#ga0">stp_list_item_t</a> *item, void *data)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the data associated with a list item.  <a href="group__list.html#ga31"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Generic list functions. 
<p>
<hr size="1"><address style="align: right;"><small>Generated on Sat Jul 2 09:45:08 2005 for libgutenprint API Reference by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.3-20050530 </small></address>
</body>
</html>