<!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: iKeyValuePair Struct Reference (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 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 class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iKeyValuePair Struct Reference</h1><!-- doxytag: class="iKeyValuePair" --><!-- doxytag: inherits="iBase" -->A Key Value pair.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ivaria_2keyval_8h-source.html">ivaria/keyval.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iKeyValuePair:</div>
<div class="dynsection">
<p><center><img src="structiKeyValuePair__inherit__graph.png" border="0" usemap="#iKeyValuePair__inherit__map" alt="Inheritance graph"></center>
<map name="iKeyValuePair__inherit__map">
<area shape="rect" href="classscfImplementationExt1.html" title="scfImplementationExt1\< csKeyValuePair, csObject, iKeyValuePair \>" alt="" coords="5,161,464,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="207,7,263,33"><area shape="rect" href="classcsKeyValuePair.html" title="A Key Value pair." alt="" coords="175,239,295,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiKeyValuePair-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#3efad4849a1f349d3a6995bd45e7e270">GetEditorOnly</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query whether this pair is an "editor-only" pair. <a href="#3efad4849a1f349d3a6995bd45e7e270"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#aa6d2a0564f5d6b3802f75c43e6b662b">GetKey</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key string of the pair. <a href="#aa6d2a0564f5d6b3802f75c43e6b662b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#cb5f4f3cc84bb54129e72d9d1743eb6c">GetValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the 'value' string of the pair. <a href="#cb5f4f3cc84bb54129e72d9d1743eb6c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#0f843e6301c2e80abed3fe791c940c39">GetValue</a> (const char *vname) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a value string from the pair. <a href="#0f843e6301c2e80abed3fe791c940c39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiStringArray.html">iStringArray</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#d2e39e32d30965df98c56ed78a3146d1">GetValueNames</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of the names of values in the pair. <a href="#d2e39e32d30965df98c56ed78a3146d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#fff0d7e2853c2eb3bcbee6363aa2827a">QueryObject</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>. <a href="#fff0d7e2853c2eb3bcbee6363aa2827a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#7cf660ac5a94d7f50789a26871721cc3">SetKey</a> (const char *key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the key string of the pair. <a href="#7cf660ac5a94d7f50789a26871721cc3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#2130cf1099c1a29bb74962efde34e5d7">SetValue</a> (const char *value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value string of the pair. <a href="#2130cf1099c1a29bb74962efde34e5d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiKeyValuePair.html#3da81793a1dc3a2b5ff79a6ec6966045">SetValue</a> (const char *vname, const char *value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a value string of the pair. <a href="#3da81793a1dc3a2b5ff79a6ec6966045"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Key Value pair.
<p>
This object contains a 'key' string and one or more 'value' strings. Typically key value pairs are specified in map files (using the <key> tag). They allow a game developer to tag game specific information to any Crystal Space object.<p>
Main creators of instances implementing this interface:<ul>
<li>The main loader creates instances of this internally.</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="group__scf.html#g2e8cf383ca5045f2b0c05374ff0107c3" title="Helper function around iBase::QueryInterface.">scfQueryInterface()</a> from <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> instances you get by calling <a class="el" href="structiObject.html#7d556c40d0c2f474559145bd257660e6" title="Return an iterator for all child objects.">iObject::GetIterator()</a> on <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> instances you get from <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> objects (typically using <a class="el" href="structiKeyValuePair.html#fff0d7e2853c2eb3bcbee6363aa2827a" title="Get the iObject.">QueryObject()</a>). </li></ul>
<p>Definition at line <a class="el" href="ivaria_2keyval_8h-source.html#l00045">45</a> of file <a class="el" href="ivaria_2keyval_8h-source.html">keyval.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3efad4849a1f349d3a6995bd45e7e270"></a><!-- doxytag: member="iKeyValuePair::GetEditorOnly" ref="3efad4849a1f349d3a6995bd45e7e270" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iKeyValuePair::GetEditorOnly </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query whether this pair is an "editor-only" pair.
<p>
They're marked as such in world files and are normally not kept in memory.
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#0f893731a8f259cf0c06140572cea217">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa6d2a0564f5d6b3802f75c43e6b662b"></a><!-- doxytag: member="iKeyValuePair::GetKey" ref="aa6d2a0564f5d6b3802f75c43e6b662b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iKeyValuePair::GetKey </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the key string of the pair.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#5a1760a1270ab9e1ff707bb99992ff77">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="cb5f4f3cc84bb54129e72d9d1743eb6c"></a><!-- doxytag: member="iKeyValuePair::GetValue" ref="cb5f4f3cc84bb54129e72d9d1743eb6c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iKeyValuePair::GetValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the 'value' string of the pair.
<p>
This is the same as calling 'GetValue ("value")'.
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#e0f1fa49c25ce848aa8555816fabdc8f">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="0f843e6301c2e80abed3fe791c940c39"></a><!-- doxytag: member="iKeyValuePair::GetValue" ref="0f843e6301c2e80abed3fe791c940c39" args="(const char *vname) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iKeyValuePair::GetValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vname</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a value string from the pair.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#68ac06903648da1ed00fa55c3f5015c0">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="d2e39e32d30965df98c56ed78a3146d1"></a><!-- doxytag: member="iKeyValuePair::GetValueNames" ref="d2e39e32d30965df98c56ed78a3146d1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiStringArray.html">iStringArray</a>> iKeyValuePair::GetValueNames </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a list of the names of values in the pair.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#f5e8a2525b975f2902b9b645f0c87c65">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="fff0d7e2853c2eb3bcbee6363aa2827a"></a><!-- doxytag: member="iKeyValuePair::QueryObject" ref="fff0d7e2853c2eb3bcbee6363aa2827a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* iKeyValuePair::QueryObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#8e41bf67cba182fcf1137fcb6a4f7b3d">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="7cf660ac5a94d7f50789a26871721cc3"></a><!-- doxytag: member="iKeyValuePair::SetKey" ref="7cf660ac5a94d7f50789a26871721cc3" args="(const char *key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iKeyValuePair::SetKey </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the key string of the pair.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#b3c00f5a5f3edb953570b6d98831a465">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="2130cf1099c1a29bb74962efde34e5d7"></a><!-- doxytag: member="iKeyValuePair::SetValue" ref="2130cf1099c1a29bb74962efde34e5d7" args="(const char *value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iKeyValuePair::SetValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the value string of the pair.
<p>
This is the same as calling 'SetValue ("value", value)'.
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#aafac3ed0e4155e4b59719fa44aa5fec">csKeyValuePair</a>.</p>
</div>
</div><p>
<a class="anchor" name="3da81793a1dc3a2b5ff79a6ec6966045"></a><!-- doxytag: member="iKeyValuePair::SetValue" ref="3da81793a1dc3a2b5ff79a6ec6966045" args="(const char *vname, const char *value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iKeyValuePair::SetValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a value string of the pair.
<p>
<p>Implemented in <a class="el" href="classcsKeyValuePair.html#fd5ac1e989f58a25a63b55e55b1667eb">csKeyValuePair</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="ivaria_2keyval_8h-source.html">keyval.h</a></ul>
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3154
