Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1932

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iutil/stringarray.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>iutil/stringarray.h</h1><a href="iutil_2stringarray_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Crystal Space String Array SCF Interface</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2003 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_IUTIL_STRINGARRAY_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IUTIL_STRINGARRAY_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span>
<a name="l00024"></a>00024 
<a name="l00032"></a>00032 
<a name="l00033"></a><a class="code" href="structiStringArray.html">00033</a> <span class="keyword">struct </span><a class="code" href="structiStringArray.html" title="This is an SCF-compatible interface for csStringArray.">iStringArray</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035   SCF_INTERFACE(<a class="code" href="structiStringArray.html" title="This is an SCF-compatible interface for csStringArray.">iStringArray</a>, 2,0,0);
<a name="l00037"></a>00037   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#cec78f975c64e4ea4a28cb321752b997" title="Get array length.">GetSize</a> () <span class="keyword">const</span> = 0;
<a name="l00038"></a>00038 
<a name="l00043"></a>00043   <span class="comment">/*CS_DEPRECATED_METHOD_MSG("Use GetSize() instead.")*/</span>
<a name="l00044"></a>00044   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#d19c0843fa56c0d8d938d1f77fc123be" title="Get array length.">Length</a> () <span class="keyword">const</span> = 0;
<a name="l00045"></a>00045 
<a name="l00047"></a>00047   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiStringArray.html#7ecf61b001d175e91287fed7fc9e1a80" title="Push a string onto the stack.">Push</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value) = 0;
<a name="l00048"></a>00048 
<a name="l00054"></a>00054   <span class="keyword">virtual</span> <span class="keywordtype">char</span> *<a class="code" href="structiStringArray.html#59152da1df4932560868c73583ab5a9e" title="Pop an element from tail end of array.">Pop</a> () = 0;
<a name="l00055"></a>00055 
<a name="l00057"></a>00057   <span class="keyword">virtual</span> <span class="keywordtype">char</span> <span class="keyword">const</span> *<a class="code" href="structiStringArray.html#1e9876f90c61e37c678f970e23dd2f29" title="Get a particular string from the array.">Get</a> (<span class="keywordtype">size_t</span> n) <span class="keyword">const</span> = 0;
<a name="l00058"></a>00058 
<a name="l00065"></a>00065   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#b0cee0dffbbd33f1459c102e8b294179" title="Find a string, case-sensitive.">Find</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value) <span class="keyword">const</span> = 0;
<a name="l00066"></a>00066 
<a name="l00073"></a>00073   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#d4e860b88c8756f36cbe91528613b90b" title="Find a string, case-insensitive.">FindCaseInsensitive</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value) <span class="keyword">const</span> = 0;
<a name="l00074"></a>00074 
<a name="l00080"></a>00080   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#9c7f5be432c2517639c8e1b085023f8f" title="Find an element based on some key, using a comparison function.">FindSortedKey</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *value) <span class="keyword">const</span> = 0;
<a name="l00081"></a>00081 
<a name="l00093"></a>00093   <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structiStringArray.html#e9924a83631f00424f31de559e4e7b65" title="Alias for Find() and FindCaseInsensitive().">Contains</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">bool</span> case_sensitive = <span class="keyword">true</span>) <span class="keyword">const</span>=0;
<a name="l00094"></a>00094 
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiStringArray.html#d8cf28fbb87797e4fcf0a34b3e66f8b6" title="Sort array.">Sort</a> (<span class="keywordtype">bool</span> case_sensitive = <span class="keyword">true</span>) = 0;
<a name="l00101"></a>00101 
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiStringArray.html#e90334de48b8483d18d7686a5ebefddc" title="Delete string n from the array.">DeleteIndex</a> (<span class="keywordtype">size_t</span> n) = 0;
<a name="l00104"></a>00104 
<a name="l00106"></a>00106   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiStringArray.html#1e7de475b450888cb75b06a61a1aaf3f" title="Insert a string before entry n in the array.">Insert</a> (<span class="keywordtype">size_t</span> n, <span class="keywordtype">char</span> <span class="keyword">const</span> *value) = 0;
<a name="l00107"></a>00107 
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiStringArray.html#58eacffb0f3c4533010d8b549da6caaa" title="Remove all strings from array, releasing allocated memory.">Empty</a> () = 0;
<a name="l00110"></a>00110 
<a name="l00115"></a>00115   <span class="comment">/*CS_DEPRECATED_METHOD_MSG("Use Empty() instead.")*/</span>
<a name="l00116"></a>00116   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiStringArray.html#c193bb89513b5dafe4ae4da10cac496d" title="Remove all strings from array.">DeleteAll</a> () = 0;
<a name="l00117"></a>00117 
<a name="l00123"></a>00123   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiStringArray.html#0f158a14100b56e742318c0cc4f9c9df" title="Return true if the array is empty.">IsEmpty</a>() <span class="keyword">const</span> = 0;
<a name="l00124"></a>00124 };
<a name="l00125"></a>00125 
<a name="l00128"></a>00128 <span class="preprocessor">#endif // __CS_IUTIL_STRINGARRAY_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>