<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libgutenprint API Reference: include/gutenprint/list.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgutenprint API Reference <span id="projectnumber">5.2.7</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">include/gutenprint/list.h File Reference</div> </div> </div> <div class="contents"> <p>Generic list functions. <a href="#details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct stp_list_item </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The list item opaque data type. <a href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct stp_list </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The list opaque data type. <a href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gac09ea139ad36a6e21f30755439afeab5">stp_node_freefunc</a> )(void *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A callback function to free the data a node contains. <a href="group__list.html#gac09ea139ad36a6e21f30755439afeab5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef void *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga8d8084abc24eb4b00290916d5ff44c1f">stp_node_copyfunc</a> )(const void *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A callback function to copy the data a node contains. <a href="group__list.html#ga8d8084abc24eb4b00290916d5ff44c1f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a> )(const void *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A callback function to get the name of a node. <a href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae5c7167d6fc957fee0b6aff45bc0b126">stp_node_sortfunc</a> )(const void *, const void *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A callback function to compare two nodes. <a href="group__list.html#gae5c7167d6fc957fee0b6aff45bc0b126"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga55fbb8f7a3920b783b02183c5ea57624">stp_list_node_free_data</a> (void *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free node data allocated with stp_malloc. <a href="group__list.html#ga55fbb8f7a3920b783b02183c5ea57624"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga3cfea94cd07f50d7d9b4ce384d349fca">stp_list_create</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new list object. <a href="group__list.html#ga3cfea94cd07f50d7d9b4ce384d349fca"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga0ba249dd06efbf5c0af8511ceab671e8">stp_list_copy</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy and allocate a list object. <a href="group__list.html#ga0ba249dd06efbf5c0af8511ceab671e8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae23ef06175b27dd6772d4d4c098999b1">stp_list_destroy</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a list object. <a href="group__list.html#gae23ef06175b27dd6772d4d4c098999b1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad185100e8d7969a473e9d42bc8084572">stp_list_get_start</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find the first item in a list. <a href="group__list.html#gad185100e8d7969a473e9d42bc8084572"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae939f15ee1a6e4c0aaad7a7be7f40b74">stp_list_get_end</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find the last item in a list. <a href="group__list.html#gae939f15ee1a6e4c0aaad7a7be7f40b74"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad377973e8b13d02c9c111d970f491993">stp_list_get_item_by_index</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, int idx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its index. <a href="group__list.html#gad377973e8b13d02c9c111d970f491993"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga729867c847dd8282f74806968c708f28">stp_list_get_item_by_name</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, const char *name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its name. <a href="group__list.html#ga729867c847dd8282f74806968c708f28"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gacc9140df3f4311cd750ba10a1cbf37d1">stp_list_get_item_by_long_name</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, const char *long_name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find an item in a list by its long name. <a href="group__list.html#gacc9140df3f4311cd750ba10a1cbf37d1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae22741060734c9cbc47656c5ea35c3f3">stp_list_get_length</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the length of a list. <a href="group__list.html#gae22741060734c9cbc47656c5ea35c3f3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae3300d7971c393d119d6fd62e2b578ec">stp_list_set_freefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gac09ea139ad36a6e21f30755439afeab5">stp_node_freefunc</a> freefunc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a list node free function. <a href="group__list.html#gae3300d7971c393d119d6fd62e2b578ec"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#gac09ea139ad36a6e21f30755439afeab5">stp_node_freefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gabfc1ef258084a3e1ad959aa3d2f053f4">stp_list_get_freefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list node free function. <a href="group__list.html#gabfc1ef258084a3e1ad959aa3d2f053f4"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga7e002ed25bbfbad236c1c619841f1ac6">stp_list_set_copyfunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga8d8084abc24eb4b00290916d5ff44c1f">stp_node_copyfunc</a> copyfunc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a list node copy function. <a href="group__list.html#ga7e002ed25bbfbad236c1c619841f1ac6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga8d8084abc24eb4b00290916d5ff44c1f">stp_node_copyfunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga686e92ee802147171e5fc723d0079b8d">stp_list_get_copyfunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list node copy function. <a href="group__list.html#ga686e92ee802147171e5fc723d0079b8d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga889af512d87a00d696acc0b6b3fafe78">stp_list_set_namefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a> namefunc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a list node name function. <a href="group__list.html#ga889af512d87a00d696acc0b6b3fafe78"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga50b1ab3c3b6b0ba7c0cf2128e2024369">stp_list_get_namefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list node name function. <a href="group__list.html#ga50b1ab3c3b6b0ba7c0cf2128e2024369"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga5be91978431b0ed48ea7919807bdcb73">stp_list_set_long_namefunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a> long_namefunc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a list node long name function. <a href="group__list.html#ga5be91978431b0ed48ea7919807bdcb73"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga815993ed02f7e9c7b5cb4680f0504d97">stp_node_namefunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gab99b3ed6da1ea739eed3f2c04fbb7fa7">stp_list_get_long_namefunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list node long name function. <a href="group__list.html#gab99b3ed6da1ea739eed3f2c04fbb7fa7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gab1d2486542b858b44b299cfcdf7d8784">stp_list_set_sortfunc</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#gae5c7167d6fc957fee0b6aff45bc0b126">stp_node_sortfunc</a> sortfunc)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set a list node sort function. <a href="group__list.html#gab1d2486542b858b44b299cfcdf7d8784"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#gae5c7167d6fc957fee0b6aff45bc0b126">stp_node_sortfunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga4b32e315d3fd23eabeffcc8d931ea454">stp_list_get_sortfunc</a> (const <a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list node sort function. <a href="group__list.html#ga4b32e315d3fd23eabeffcc8d931ea454"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gae726297a82e140672a018e135ffc6a0e">stp_list_item_create</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *next, const void *data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new list item. <a href="group__list.html#gae726297a82e140672a018e135ffc6a0e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga5e36d4f61e00cb3e4c4a759f5e7e9f4b">stp_list_item_destroy</a> (<a class="el" href="group__list.html#ga53cf4f01ab7d712f771cb5fb479d2ba7">stp_list_t</a> *list, <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a list item. <a href="group__list.html#ga5e36d4f61e00cb3e4c4a759f5e7e9f4b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gabaa2a241055402438a0cae6f40cf6a78">stp_list_item_prev</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the previous item in the list. <a href="group__list.html#gabaa2a241055402438a0cae6f40cf6a78"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#ga81ab310caf6432ce1e492eaafdb6c0d7">stp_list_item_next</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next item in the list. <a href="group__list.html#ga81ab310caf6432ce1e492eaafdb6c0d7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gad6f6b303b40fa75f22a86391785178cb">stp_list_item_get_data</a> (const <a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the data associated with a list item. <a href="group__list.html#gad6f6b303b40fa75f22a86391785178cb"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__list.html#gac1e34edcd47ffdc119cdcaf5ad38e1c4">stp_list_item_set_data</a> (<a class="el" href="group__list.html#ga67b4fafe1ab6ead5be7500f88874bdb0">stp_list_item_t</a> *item, void *data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data associated with a list item. <a href="group__list.html#gac1e34edcd47ffdc119cdcaf5ad38e1c4"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Generic list functions. </p> </div></div> <hr class="footer"/><address class="footer"><small>Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>