summaryrefslogtreecommitdiff
path: root/doc/gutenprint/html/list_8h.html
blob: afe1d6607824f7aa411267acac8f9582f32bbfbc (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
121
122
123
124
125
126
127
128
129
130
131
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgutenprint API Reference: include/gutenprint/list.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.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>include/gutenprint/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 struct stp_list_item&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#g67b4fafe1ab6ead5be7500f88874bdb0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct stp_list&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g53cf4f01ab7d712f771cb5fb479d2ba7"></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#gc09ea139ad36a6e21f30755439afeab5">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#gc09ea139ad36a6e21f30755439afeab5"></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#g8d8084abc24eb4b00290916d5ff44c1f">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#g8d8084abc24eb4b00290916d5ff44c1f"></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#g815993ed02f7e9c7b5cb4680f0504d97">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#g815993ed02f7e9c7b5cb4680f0504d97"></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#ge5c7167d6fc957fee0b6aff45bc0b126">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#ge5c7167d6fc957fee0b6aff45bc0b126"></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#g55fbb8f7a3920b783b02183c5ea57624">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#g55fbb8f7a3920b783b02183c5ea57624"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g3cfea94cd07f50d7d9b4ce384d349fca">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#g3cfea94cd07f50d7d9b4ce384d349fca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g0ba249dd06efbf5c0af8511ceab671e8">stp_list_copy</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g0ba249dd06efbf5c0af8511ceab671e8"></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#ge23ef06175b27dd6772d4d4c098999b1">stp_list_destroy</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#ge23ef06175b27dd6772d4d4c098999b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gd185100e8d7969a473e9d42bc8084572">stp_list_get_start</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#gd185100e8d7969a473e9d42bc8084572"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ge939f15ee1a6e4c0aaad7a7be7f40b74">stp_list_get_end</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#ge939f15ee1a6e4c0aaad7a7be7f40b74"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gd377973e8b13d02c9c111d970f491993">stp_list_get_item_by_index</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#gd377973e8b13d02c9c111d970f491993"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g729867c847dd8282f74806968c708f28">stp_list_get_item_by_name</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g729867c847dd8282f74806968c708f28"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gcc9140df3f4311cd750ba10a1cbf37d1">stp_list_get_item_by_long_name</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#gcc9140df3f4311cd750ba10a1cbf37d1"></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#ge22741060734c9cbc47656c5ea35c3f3">stp_list_get_length</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#ge22741060734c9cbc47656c5ea35c3f3"></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#ge3300d7971c393d119d6fd62e2b578ec">stp_list_set_freefunc</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gc09ea139ad36a6e21f30755439afeab5">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#ge3300d7971c393d119d6fd62e2b578ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#gc09ea139ad36a6e21f30755439afeab5">stp_node_freefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gbfc1ef258084a3e1ad959aa3d2f053f4">stp_list_get_freefunc</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#gbfc1ef258084a3e1ad959aa3d2f053f4"></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#g7e002ed25bbfbad236c1c619841f1ac6">stp_list_set_copyfunc</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#g8d8084abc24eb4b00290916d5ff44c1f">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#g7e002ed25bbfbad236c1c619841f1ac6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g8d8084abc24eb4b00290916d5ff44c1f">stp_node_copyfunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g686e92ee802147171e5fc723d0079b8d">stp_list_get_copyfunc</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g686e92ee802147171e5fc723d0079b8d"></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#g889af512d87a00d696acc0b6b3fafe78">stp_list_set_namefunc</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#g815993ed02f7e9c7b5cb4680f0504d97">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#g889af512d87a00d696acc0b6b3fafe78"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g50b1ab3c3b6b0ba7c0cf2128e2024369">stp_list_get_namefunc</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g50b1ab3c3b6b0ba7c0cf2128e2024369"></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#g5be91978431b0ed48ea7919807bdcb73">stp_list_set_long_namefunc</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#g815993ed02f7e9c7b5cb4680f0504d97">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#g5be91978431b0ed48ea7919807bdcb73"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gb99b3ed6da1ea739eed3f2c04fbb7fa7">stp_list_get_long_namefunc</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#gb99b3ed6da1ea739eed3f2c04fbb7fa7"></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#gb1d2486542b858b44b299cfcdf7d8784">stp_list_set_sortfunc</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ge5c7167d6fc957fee0b6aff45bc0b126">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#gb1d2486542b858b44b299cfcdf7d8784"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#ge5c7167d6fc957fee0b6aff45bc0b126">stp_node_sortfunc</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g4b32e315d3fd23eabeffcc8d931ea454">stp_list_get_sortfunc</a> (const <a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">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#g4b32e315d3fd23eabeffcc8d931ea454"></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#ge726297a82e140672a018e135ffc6a0e">stp_list_item_create</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#ge726297a82e140672a018e135ffc6a0e"></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#g5e36d4f61e00cb3e4c4a759f5e7e9f4b">stp_list_item_destroy</a> (<a class="el" href="group__list.html#g53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#g5e36d4f61e00cb3e4c4a759f5e7e9f4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gbaa2a241055402438a0cae6f40cf6a78">stp_list_item_prev</a> (const <a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#gbaa2a241055402438a0cae6f40cf6a78"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#g81ab310caf6432ce1e492eaafdb6c0d7">stp_list_item_next</a> (const <a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#g81ab310caf6432ce1e492eaafdb6c0d7"></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#gd6f6b303b40fa75f22a86391785178cb">stp_list_item_get_data</a> (const <a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#gd6f6b303b40fa75f22a86391785178cb"></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#gc1e34edcd47ffdc119cdcaf5ad38e1c4">stp_list_item_set_data</a> (<a class="el" href="group__list.html#g67b4fafe1ab6ead5be7500f88874bdb0">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#gc1e34edcd47ffdc119cdcaf5ad38e1c4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Generic list functions. 
<p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 11 20:12:56 2010 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.5.6 </small></address>
</body>
</html>