diff options
Diffstat (limited to 'doc/api-documentation/html/class_listkey.html')
| -rw-r--r-- | doc/api-documentation/html/class_listkey.html | 540 |
1 files changed, 0 insertions, 540 deletions
diff --git a/doc/api-documentation/html/class_listkey.html b/doc/api-documentation/html/class_listkey.html deleted file mode 100644 index ed38500..0000000 --- a/doc/api-documentation/html/class_listkey.html +++ /dev/null @@ -1,540 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<html><head><meta name="robots" content="noindex"> -<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>ListKey class Reference</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -</head><body bgcolor="#ffffff"> -<!-- Generated by Doxygen 1.2.6 --> -<center> -<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> -<hr><h1>ListKey Class Reference</h1>ListKey is the basis for all types of keys that have lists of specified indexes (e.g. -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="listkey_h-source.html">listkey.h</a>></code> -<p> -<p>Inheritance diagram for ListKey:: -<p><center><img src="class_listkey.gif" usemap="#ListKey_map" border="0"></center> -<map name="ListKey_map"> -<area href="class_swkey.html" alt="SWKey" shape="rect" coords="0,56,68,80"> -<area href="class_swobject.html" alt="SWObject" shape="rect" coords="0,0,68,24"> -</map> -<a href="class_listkey-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> -<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_listkey.html#a0">ListKey</a> (const char *ikey=0)</td></tr> -<tr><td> </td><td><font size=-1><em>initializes instance of ListKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a1" doxytag="ListKey::ListKey"></a> - </td><td valign=bottom><b>ListKey</b> (ListKey const &k)</td></tr> -<tr><td nowrap align=right valign=top><a name="a2" doxytag="ListKey::~ListKey"></a> -virtual </td><td valign=bottom><a class="el" href="class_listkey.html#a2">~ListKey</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>cleans up instance of ListKey.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_listkey.html#a3">clone</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Returns a copy of this <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a4" doxytag="ListKey::ClearList"></a> -virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a4">ClearList</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Clears out elements of list.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_listkey.html#a5">Count</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Returns number of elements in list.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a6" doxytag="ListKey::Remove"></a> -virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a6">Remove</a> ()</td></tr> -<tr><td> </td><td><font size=-1><em>Removes current element from list.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_listkey.html#a7">SetToElement</a> (int ielement, SW_POSITION=TOP)</td></tr> -<tr><td> </td><td><font size=-1><em>Sets key to element number.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_listkey.html#a8">GetElement</a> (int pos=-1)</td></tr> -<tr><td> </td><td><font size=-1><em>Gets a key element number.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>ListKey& </td><td valign=bottom><a class="el" href="class_listkey.html#a9">operator<<</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Adds an element to the list.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a10" doxytag="ListKey::add"></a> -virtual void </td><td valign=bottom><b>add</b> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a11">copyFrom</a> (const ListKey &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Equates this ListKey to another ListKey object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a12">copyFrom</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> -<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a13">setPosition</a> (SW_POSITION)</td></tr> -<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a14" doxytag="ListKey::decrement"></a> -virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a14">decrement</a> (int step)</td></tr> -<tr><td> </td><td><font size=-1><em>Decrements a number of elements.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a15" doxytag="ListKey::increment"></a> -virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a15">increment</a> (int step)</td></tr> -<tr><td> </td><td><font size=-1><em>Increments a number of elements.</em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a16" doxytag="ListKey::Traversable"></a> -virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> -<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_listkey.html#a17">Index</a> () const</td></tr> -<tr><td> </td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_listkey.html#a18">Index</a> (long index)</td></tr> -<tr><td> </td><td><font size=-1><em>Returns the index for the new one given as as parameter.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a name="a19" doxytag="ListKey::operator="></a> -SWKEY_OPERATORS ListKey& </td><td valign=bottom><b>operator=</b> (const ListKey &key)</td></tr> -<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="n0" doxytag="ListKey::arraypos"></a> -int </td><td valign=bottom><b>arraypos</b></td></tr> -<tr><td nowrap align=right valign=top><a name="n1" doxytag="ListKey::arraymax"></a> -int </td><td valign=bottom><b>arraymax</b></td></tr> -<tr><td nowrap align=right valign=top><a name="n2" doxytag="ListKey::arraycnt"></a> -int </td><td valign=bottom><b>arraycnt</b></td></tr> -<tr><td nowrap align=right valign=top><a name="n3" doxytag="ListKey::array"></a> -<a class="el" href="class_swkey.html">SWKey</a>** </td><td valign=bottom><b>array</b></td></tr> -<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="c0" doxytag="ListKey::init"></a> -void </td><td valign=bottom><b>init</b> ()</td></tr> -<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top><a name="r0" doxytag="ListKey::classdef"></a> -<a class="el" href="class_swclass.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -ListKey is the basis for all types of keys that have lists of specified indexes (e.g. -<p> -a list of verses, place, etc.) -<p> - -<p> -Definition at line <a class="el" href="listkey_h-source.html#l00036">36</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> -<a name="a0" doxytag="ListKey::ListKey"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -ListKey::ListKey ( - </b></td> - <td valign="bottom"><b> -const char * <em>ikey</em> = 0 ) - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -initializes instance of ListKey. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey</em> - </td><td> -text key </td></tr> -</table> -</dl> </td> - </tr> -</table> -<hr><h2>Member Function Documentation</h2> -<a name="a5" doxytag="ListKey::Count"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -int ListKey::Count ( - </b></td> - <td valign="bottom"><b> -)<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Returns number of elements in list. -<p> -<dl compact><dt> -<b>Returns: </b><dd> -number of elements in list </dl> </td> - </tr> -</table> -<a name="a8" doxytag="ListKey::GetElement"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -<a class="el" href="class_swkey.html">SWKey</a> * ListKey::GetElement ( - </b></td> - <td valign="bottom"><b> -int <em>pos</em> = -1 )<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Gets a key element number. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>pos</em> - </td><td> -element number to get (or default current) </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -Key or null on error </dl> </td> - </tr> -</table> -<a name="a18" doxytag="ListKey::Index"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -long ListKey::Index ( - </b></td> - <td valign="bottom"><b> -long <em>index</em> )<code> [inline, virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Returns the index for the new one given as as parameter. -<p> -The first parameter is the new index. -<p> -Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. -<p> -Definition at line <a class="el" href="listkey_h-source.html#l00112">112</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> - </tr> -</table> -<a name="a17" doxytag="ListKey::Index"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -long ListKey::Index ( - </b></td> - <td valign="bottom"><b> -) const<code> [inline, virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Use this function to get te current position withing a module. -<p> -Here's a small example how to use this function and <a class="el" href="class_listkey.html#a18">Index</a>(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{ - <a class="code" href="class_versekey.html">VerseKey</a> vk; - <a class="code" href="class_swmgr.html">SWMgr</a> mgr; - LocaleMgr::systemLocaleMgr.<a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>); - - <a class="code" href="class_swmodule.html">SWModule</a>* module = mgr-><a class="code" href="class_swmgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>); - srand( time(0) ); - <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224); - vk.<a class="code" href="class_versekey.html#a31">Index</a>(newIndex); - module-><a class="code" href="class_swmodule.html#a5">SetKey</a>(vk); - - <font class="keywordtype">char</font>* text; - sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-><a class="code" href="class_swmodule.html#a43">StripText</a>(&vk)); - <font class="keywordflow">return</font> text;</pre></div> -<p> -Reimplemented from <a class="el" href="class_swkey.html#a16">SWKey</a>. -<p> -Definition at line <a class="el" href="listkey_h-source.html#l00106">106</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> - </tr> -</table> -<a name="a7" doxytag="ListKey::SetToElement"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -char ListKey::SetToElement ( - </b></td> - <td valign="bottom"><b> -int <em>ielement</em>, - </b></td> - </tr> - <tr> - <td></td> - <td><b> -SW_POSITION = TOP )<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Sets key to element number. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ielement</em> - </td><td> -element number to set to </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -error status </dl> -<p> -Referenced by <a class="el" href="listkey_h-source.html#l00112">Index</a>(). </td> - </tr> -</table> -<a name="a3" doxytag="ListKey::clone"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -virtual <a class="el" href="class_swkey.html">SWKey</a>* ListKey::clone ( - </b></td> - <td valign="bottom"><b> -) const<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Returns a copy of this <a class="el" href="class_swkey.html">SWKey</a> object. -<p> -This is useful to get a 1:1 copy of an <a class="el" href="class_swkey.html">SWKey</a> based object. <dl compact><dt> -<b>Returns: </b><dd> -<a class="el" href="class_swkey.html">SWKey</a> </dl> -<p> -Reimplemented from <a class="el" href="class_swkey.html#a3">SWKey</a>. </td> - </tr> -</table> -<a name="a12" doxytag="ListKey::copyFrom"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -void ListKey::copyFrom ( - </b></td> - <td valign="bottom"><b> -const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [inline, virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey</em> - </td><td> -other swkey object </td></tr> -</table> -</dl> -<p> -Reimplemented from <a class="el" href="class_swkey.html#a8">SWKey</a>. -<p> -Definition at line <a class="el" href="listkey_h-source.html#l00090">90</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> - </tr> -</table> -<a name="a11" doxytag="ListKey::copyFrom"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -void ListKey::copyFrom ( - </b></td> - <td valign="bottom"><b> -const ListKey & <em>ikey</em> )<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Equates this ListKey to another ListKey object. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey</em> - </td><td> -other ListKey object </td></tr> -</table> -</dl> </td> - </tr> -</table> -<a name="a9" doxytag="ListKey::operator<<"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -ListKey & ListKey::operator<< ( - </b></td> - <td valign="bottom"><b> -const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [inline]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Adds an element to the list. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>ikey</em> - </td><td> -the element to add </td></tr> -</table> -</dl> -<p> -Definition at line <a class="el" href="listkey_h-source.html#l00082">82</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> - </tr> -</table> -<a name="a13" doxytag="ListKey::setPosition"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -void ListKey::setPosition ( - </b></td> - <td valign="bottom"><b> -SW_POSITION )<code> [virtual]</code> - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Positions this key. -<p> -<dl compact><dt> -<b>Parameters: </b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em>p</em> - </td><td> -position </td></tr> -</table> -</dl><dl compact><dt> -<b>Returns: </b><dd> -*this </dl> -<p> -Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. </td> - </tr> -</table> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="listkey_h-source.html">listkey.h</a></ul> -<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by -<a href="http://www.doxygen.org/index.html"> -<img src="doxygen.gif" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, - © 1997-2001</small></address> -</body> -</html> |