<html> <head><title>ClanLib Reference: CL_ResourceOption</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_ResourceOption</h1><p> <b> Resource Option Class</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Core (Resources) <p> #include <ClanLib/core.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1213"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>value</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1214"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1215"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1216"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_ResourceOption.html#1216"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a>& <tt><font color=blue>other</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_ResourceOption.html#1217"><tt><font color=blue><b>get_name</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_ResourceOption.html#1218"><tt><font color=blue><b>get_value</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>i</font></tt>=0) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=navy>std::vector</font></tt><<tt><font color=navy>std::string</font></tt>>&</tt> </td><td align=right><a href="CL_ResourceOption.html#1219"><tt><font color=blue><b>get_values</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=left><h3>Operations:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1220"><tt><font color=black><b>operator</b></font></tt><tt> =</tt></a></td><td><tt>(<tt>const</tt> <a href="CL_ResourceOption.html#1216"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a>& <tt><font color=blue>other</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_ResourceOption.html#1221"><tt><font color=blue><b>add_value</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>value</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> Holds the particular options for a resource<br> Used by the ResourceManager and DataFile compiler<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1213"><font size=+1><b>CL_ResourceOption::CL_ResourceOption</b></font></a> - Resource Option Constructor<br><tt></tt> <a href="CL_ResourceOption.html#1213"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>value</font></tt>)</tt>;<br><blockquote> name - The name of the option<br> value - Value of the option as a string</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1214"><font size=+1><b>CL_ResourceOption::CL_ResourceOption</b></font></a> - Resource Option Constructor<br><tt></tt> <a href="CL_ResourceOption.html#1214"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>name</font></tt>)</tt>;<br><blockquote> name - The name of the option.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1215"><font size=+1><b>CL_ResourceOption::CL_ResourceOption</b></font></a> - Default Resource Option Constructor<br><tt></tt> <a href="CL_ResourceOption.html#1215"><tt><font color=blue><b>CL_ResourceOption</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1221"><font size=+1><b>CL_ResourceOption::add_value</b></font></a> - Add a Value<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_ResourceOption.html#1221"><tt><font color=blue><b>add_value</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>value</font></tt>)</tt>;<br><blockquote> value - the string value to add<br> Returns - the index of the added value</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1217"><font size=+1><b>CL_ResourceOption::get_name</b></font></a> - Get Name<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_ResourceOption.html#1217"><tt><font color=blue><b>get_name</b></font></tt></a><tt>() <tt>const</tt></tt>;<br><blockquote> Returns - The name of the option</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1218"><font size=+1><b>CL_ResourceOption::get_value</b></font></a> - Get Value<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_ResourceOption.html#1218"><tt><font color=blue><b>get_value</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>i</font></tt>=0) <tt>const</tt></tt>;<br><blockquote> i - The index of which value to return, default of 0<br> Returns - The option for the index value of i.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1219"><font size=+1><b>CL_ResourceOption::get_values</b></font></a> - Get Values<br><tt><tt><font color=navy>std::vector</font></tt><<tt><font color=navy>std::string</font></tt>>&</tt> <a href="CL_ResourceOption.html#1219"><tt><font color=blue><b>get_values</b></font></tt></a><tt>()</tt>;<br><blockquote> Returns - An std::vector<std::string> with all the values.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>