<!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: csVariant 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>csVariant Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="csVariant" -->Variant, means that type of contained data is set at runtime.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="pluginconfig_8h-source.html">iutil/pluginconfig.h</a>></code>
<p>
<p>
<a href="structcsVariant-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#4ebfd4836c17bc6b3a1ddc97c8e513db">csVariant</a> (const <a class="el" href="structcsVariant.html">csVariant</a> &var)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor - only IncRef's the String, should our type be a string. <a href="#4ebfd4836c17bc6b3a1ddc97c8e513db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6594afe4ffa4a685e030779a9a811975"></a><!-- doxytag: member="csVariant::csVariant" ref="6594afe4ffa4a685e030779a9a811975" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#6594afe4ffa4a685e030779a9a811975">csVariant</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#36fa1d06d3d829ca555a9985a596b43c">GetBool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a bool. <a href="#36fa1d06d3d829ca555a9985a596b43c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#d4ffafd84f2eac8e44ced0bb87312e4e">GetFloat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a float. <a href="#d4ffafd84f2eac8e44ced0bb87312e4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#babd9d1ee88facf3a25afc5911d4fdee">GetLong</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a long. <a href="#babd9d1ee88facf3a25afc5911d4fdee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#2ad7fab5668e57b446c12e8bed91e3b0">GetString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a string. <a href="#2ad7fab5668e57b446c12e8bed91e3b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0aa9f6d202cc90e06447f70c238f44c2"></a><!-- doxytag: member="csVariant::GetType" ref="0aa9f6d202cc90e06447f70c238f44c2" args="() const " -->
<a class="el" href="group__util.html#g91624a433f78618fba6823a5d79bdb52">csVariantType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#0aa9f6d202cc90e06447f70c238f44c2">GetType</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structcsVariant.html">csVariant</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#8becb055148eb778d7100400b9f7263a">operator=</a> (const <a class="el" href="structcsVariant.html">csVariant</a> &var)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. As with the copy-ctor, only IncRef's the string. <a href="#8becb055148eb778d7100400b9f7263a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#6c45850ca04ce0b460a95c4433a584b5">SetBool</a> (bool b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a bool. <a href="#6c45850ca04ce0b460a95c4433a584b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#1f651e489b425485c7ba4620b8b571b4">SetCommand</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a command. <a href="#1f651e489b425485c7ba4620b8b571b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#8c0a880bd68da00c11776cb4b75ce291">SetFloat</a> (float f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a float. <a href="#8c0a880bd68da00c11776cb4b75ce291"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#6ae9d0b1f1dbe2b0d190425d1b584f68">SetLong</a> (long l)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a long. <a href="#6ae9d0b1f1dbe2b0d190425d1b584f68"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#70568ffe2ca094b6da29a5264da53fa6">SetString</a> (const char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a string. <a href="#70568ffe2ca094b6da29a5264da53fa6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1be8c7cdc8e6205ce578bf34d7567349"></a><!-- doxytag: member="csVariant::~csVariant" ref="1be8c7cdc8e6205ce578bf34d7567349" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsVariant.html#1be8c7cdc8e6205ce578bf34d7567349">~csVariant</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Variant, means that type of contained data is set at runtime.
<p>
Be aware that requesting another type than the containing one will trigger an assertion!
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00050">50</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4ebfd4836c17bc6b3a1ddc97c8e513db"></a><!-- doxytag: member="csVariant::csVariant" ref="4ebfd4836c17bc6b3a1ddc97c8e513db" args="(const csVariant &var)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csVariant::csVariant </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcsVariant.html">csVariant</a> & </td>
<td class="paramname"> <em>var</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor - only IncRef's the String, should our type be a string.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00070">70</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00042">CSVAR_STRING</a>, <a class="el" href="pluginconfig_8h-source.html#l00053">type</a>, and v.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="36fa1d06d3d829ca555a9985a596b43c"></a><!-- doxytag: member="csVariant::GetBool" ref="36fa1d06d3d829ca555a9985a596b43c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csVariant::GetBool </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a bool.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00134">134</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="pluginconfig_8h-source.html#l00036">CSVAR_BOOL</a>.</p>
</div>
</div><p>
<a class="anchor" name="d4ffafd84f2eac8e44ced0bb87312e4e"></a><!-- doxytag: member="csVariant::GetFloat" ref="d4ffafd84f2eac8e44ced0bb87312e4e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float csVariant::GetFloat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a float.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00140">140</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="pluginconfig_8h-source.html#l00040">CSVAR_FLOAT</a>.</p>
</div>
</div><p>
<a class="anchor" name="babd9d1ee88facf3a25afc5911d4fdee"></a><!-- doxytag: member="csVariant::GetLong" ref="babd9d1ee88facf3a25afc5911d4fdee" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long csVariant::GetLong </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a long.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00128">128</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="pluginconfig_8h-source.html#l00034">CSVAR_LONG</a>.</p>
</div>
</div><p>
<a class="anchor" name="2ad7fab5668e57b446c12e8bed91e3b0"></a><!-- doxytag: member="csVariant::GetString" ref="2ad7fab5668e57b446c12e8bed91e3b0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* csVariant::GetString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve a string.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00146">146</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="pluginconfig_8h-source.html#l00042">CSVAR_STRING</a>.</p>
</div>
</div><p>
<a class="anchor" name="8becb055148eb778d7100400b9f7263a"></a><!-- doxytag: member="csVariant::operator=" ref="8becb055148eb778d7100400b9f7263a" args="(const csVariant &var)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structcsVariant.html">csVariant</a>& csVariant::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcsVariant.html">csVariant</a> & </td>
<td class="paramname"> <em>var</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator. As with the copy-ctor, only IncRef's the string.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00080">80</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00042">CSVAR_STRING</a>, <a class="el" href="pluginconfig_8h-source.html#l00053">type</a>, and v.</p>
</div>
</div><p>
<a class="anchor" name="6c45850ca04ce0b460a95c4433a584b5"></a><!-- doxytag: member="csVariant::SetBool" ref="6c45850ca04ce0b460a95c4433a584b5" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csVariant::SetBool </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign a bool.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00097">97</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00036">CSVAR_BOOL</a>.</p>
</div>
</div><p>
<a class="anchor" name="1f651e489b425485c7ba4620b8b571b4"></a><!-- doxytag: member="csVariant::SetCommand" ref="1f651e489b425485c7ba4620b8b571b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csVariant::SetCommand </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign a command.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00121">121</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00038">CSVAR_CMD</a>.</p>
</div>
</div><p>
<a class="anchor" name="8c0a880bd68da00c11776cb4b75ce291"></a><!-- doxytag: member="csVariant::SetFloat" ref="8c0a880bd68da00c11776cb4b75ce291" args="(float f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csVariant::SetFloat </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>f</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign a float.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00104">104</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00040">CSVAR_FLOAT</a>.</p>
</div>
</div><p>
<a class="anchor" name="6ae9d0b1f1dbe2b0d190425d1b584f68"></a><!-- doxytag: member="csVariant::SetLong" ref="6ae9d0b1f1dbe2b0d190425d1b584f68" args="(long l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csVariant::SetLong </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>l</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign a long.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00090">90</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00034">CSVAR_LONG</a>.</p>
</div>
</div><p>
<a class="anchor" name="70568ffe2ca094b6da29a5264da53fa6"></a><!-- doxytag: member="csVariant::SetString" ref="70568ffe2ca094b6da29a5264da53fa6" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csVariant::SetString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign a string.
<p>
<p>Definition at line <a class="el" href="pluginconfig_8h-source.html#l00111">111</a> of file <a class="el" href="pluginconfig_8h-source.html">pluginconfig.h</a>.</p>
<p>References <a class="el" href="pluginconfig_8h-source.html#l00042">CSVAR_STRING</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="pluginconfig_8h-source.html">pluginconfig.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
>
2751
