diff options
Diffstat (limited to 'c-layman/doc/html/group__string__list.html')
| -rw-r--r-- | c-layman/doc/html/group__string__list.html | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/c-layman/doc/html/group__string__list.html b/c-layman/doc/html/group__string__list.html new file mode 100644 index 0000000..f6b3402 --- /dev/null +++ b/c-layman/doc/html/group__string__list.html @@ -0,0 +1,247 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C-Layman: StringList</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.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</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><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>StringList</h1>String list management class. +<a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_string_list.html">StringList</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="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#gafedcfd6148313464f9aab9c08f87989">stringListCreate</a> (size_t len)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g28cd2d1037d735a5ac3275897b0c2065">stringListInsertAt</a> (<a class="el" href="struct_string_list.html">StringList</a> *l, unsigned int pos, char *str)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g307b9dca62828cbfe5c163d327f01806">stringListCount</a> (<a class="el" href="struct_string_list.html">StringList</a> *l)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g43bc91c5da9f06e7c972c8f04b3a99c2">stringListGetAt</a> (<a class="el" href="struct_string_list.html">StringList</a> *l, unsigned int pos)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g3ed6624cf1e5f944068f803964be6c95">stringListPrint</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#ged41020feb3f2b869647cc280b493cb3">stringListFree</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g52128fb831cc1a4643950bbc2ec31391">listToCList</a> (PyObject *list)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__string__list.html#g2433a3f25f9fd7950892807717b8e0bd">cListToPyList</a> (<a class="el" href="struct_string_list.html">StringList</a> *list)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +String list management class. <hr><h2>Function Documentation</h2> +<a class="anchor" name="g2433a3f25f9fd7950892807717b8e0bd"></a><!-- doxytag: member="stringlist.c::cListToPyList" ref="g2433a3f25f9fd7950892807717b8e0bd" args="(StringList *list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PyObject* cListToPyList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Converts a C String list to a Python List object +</div> +</div><p> +<a class="anchor" name="g52128fb831cc1a4643950bbc2ec31391"></a><!-- doxytag: member="stringlist.c::listToCList" ref="g52128fb831cc1a4643950bbc2ec31391" args="(PyObject *list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* listToCList </td> + <td>(</td> + <td class="paramtype">PyObject * </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<h2><a class="anchor" name="internal"> +internal</a></h2> +Converts a Python list object to a C String list +</div> +</div><p> +<a class="anchor" name="g307b9dca62828cbfe5c163d327f01806"></a><!-- doxytag: member="stringlist.c::stringListCount" ref="g307b9dca62828cbfe5c163d327f01806" args="(StringList *l)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int stringListCount </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>l</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the number of strings in the list.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of strings in the list </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gafedcfd6148313464f9aab9c08f87989"></a><!-- doxytag: member="stringlist.c::stringListCreate" ref="gafedcfd6148313464f9aab9c08f87989" args="(size_t len)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* stringListCreate </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"> <em>len</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a String list to use with the library. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>the number of strings in the list. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="ged41020feb3f2b869647cc280b493cb3"></a><!-- doxytag: member="stringlist.c::stringListFree" ref="ged41020feb3f2b869647cc280b493cb3" args="(StringList *list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void stringListFree </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Frees a string list and it's data +</div> +</div><p> +<a class="anchor" name="g43bc91c5da9f06e7c972c8f04b3a99c2"></a><!-- doxytag: member="stringlist.c::stringListGetAt" ref="g43bc91c5da9f06e7c972c8f04b3a99c2" args="(StringList *l, unsigned int pos)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* stringListGetAt </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>pos</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the String at position pos <dl class="return" compact><dt><b>Returns:</b></dt><dd>the String at position pos </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g28cd2d1037d735a5ac3275897b0c2065"></a><!-- doxytag: member="stringlist.c::stringListInsertAt" ref="g28cd2d1037d735a5ac3275897b0c2065" args="(StringList *l, unsigned int pos, char *str)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int stringListInsertAt </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>str</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Inserts the string str in the list l at position pos. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g3ed6624cf1e5f944068f803964be6c95"></a><!-- doxytag: member="stringlist.c::stringListPrint" ref="g3ed6624cf1e5f944068f803964be6c95" args="(StringList *list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void stringListPrint </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Prints a C String list. +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |