<html> <head><title>ClanLib Reference: CL_ComponentOptions</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_ComponentOptions</h1><p> <b> Sets the options for components</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: GUI (Framework) <p> #include <ClanLib/gui.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>Attributes:</h3></td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_ComponentOptions.html#2807"><tt><font color=blue><b>exists</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>) <tt>const</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_ComponentOptions.html#2808"><tt><font color=blue><b>count</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_ComponentOptions.html#2809"><tt><font color=blue><b>remove_option</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></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_ComponentOptions.html#2810"><tt><font color=blue><b>get_value</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <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_ComponentOptions.html#2811"><tt><font color=black><b>operator</b></font></tt><tt> []</tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>) <tt>const</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_ComponentOptions.html#2812"><tt><font color=blue><b>get_value_as_int</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_ComponentOptions.html#2813"><tt><font color=blue><b>get_value_as_bool</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <tt>const</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_ComponentOptions.html#2814"><tt><font color=blue><b>add_option</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_value</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_ComponentOptions.html#2815"><tt><font color=blue><b>add_option</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>option_value</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_ComponentOptions.html#2816"><tt><font color=blue><b>clear</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ComponentOptions.html#2805">iterator</a></tt> </td><td align=right><a href="CL_ComponentOptions.html#2817"><tt><font color=blue><b>begin</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ComponentOptions.html#2805">iterator</a></tt> </td><td align=right><a href="CL_ComponentOptions.html#2818"><tt><font color=blue><b>end</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ComponentOptions.html#2806">const_iterator</a></tt> </td><td align=right><a href="CL_ComponentOptions.html#2819"><tt><font color=blue><b>begin</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_ComponentOptions.html#2806">const_iterator</a></tt> </td><td align=right><a href="CL_ComponentOptions.html#2820"><tt><font color=blue><b>end</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2814"><font size=+1><b>CL_ComponentOptions::add_option</b></font></a> - Add option<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_ComponentOptions.html#2814"><tt><font color=blue><b>add_option</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_value</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2815"><font size=+1><b>CL_ComponentOptions::add_option</b></font></a> - Add option<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_ComponentOptions.html#2815"><tt><font color=blue><b>add_option</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>option_value</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2816"><font size=+1><b>CL_ComponentOptions::clear</b></font></a> - Clear<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_ComponentOptions.html#2816"><tt><font color=blue><b>clear</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2808"><font size=+1><b>CL_ComponentOptions::count</b></font></a> - Count<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_ComponentOptions.html#2808"><tt><font color=blue><b>count</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2807"><font size=+1><b>CL_ComponentOptions::exists</b></font></a> - Exists<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_ComponentOptions.html#2807"><tt><font color=blue><b>exists</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2810"><font size=+1><b>CL_ComponentOptions::get_value</b></font></a> - Getting the value of a unexisting option is undefined, so use the 'exists' function<br> first to check if the option exists<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_ComponentOptions.html#2810"><tt><font color=blue><b>get_value</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2813"><font size=+1><b>CL_ComponentOptions::get_value_as_bool</b></font></a> - Get value as bool<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_ComponentOptions.html#2813"><tt><font color=blue><b>get_value_as_bool</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2812"><font size=+1><b>CL_ComponentOptions::get_value_as_int</b></font></a> - Get value as int<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_ComponentOptions.html#2812"><tt><font color=blue><b>get_value_as_int</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>option_name</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>offset</font></tt>=0) <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="2821"><font size=+1><b>CL_ComponentOptions::options</b></font></a> - Options<br> <tt><a href="CL_ComponentOptions.html#2804">options_t</a> </tt> <tt><a href="CL_ComponentOptions.html#2821"><tt><font color=blue>options</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
