<html> <head><title>ClanLib Reference: CL_Button</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_Button</h1><p> <b> Button component</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <a href="CL_Component.html">CL_Component</a> <br> Derived by: <a href="CL_CheckBox.html">CL_CheckBox</a> <a href="CL_RadioButton.html">CL_RadioButton</a> <br>Group: GUI (Controls) <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>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2527"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2528"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2529"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2530"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Rect.html"><tt><font color=navy><b>CL_Rect</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2531"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_up</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_down</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2532"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_up</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_down</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_disabled</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_highlighted</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Button.html#2533"><tt><font color=blue><b>~CL_Button</b></font></tt></a></td><td><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_Button.html#2534"><tt><font color=blue><b>get_text</b></font></tt></a></td><td><tt>() <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_Button.html#2535"><tt><font color=blue><b>is_toggle_button</b></font></tt></a></td><td><tt>() <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_Button.html#2536"><tt><font color=blue><b>is_down</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Button.html#2537"><tt><font color=blue><b>get_surface_up</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Button.html#2538"><tt><font color=blue><b>get_surface_down</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Button.html#2539"><tt><font color=blue><b>get_surface_highlighted</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> </td><td align=right><a href="CL_Button.html#2540"><tt><font color=blue><b>get_surface_disabled</b></font></tt></a></td><td><tt>() <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_Button.html#2541"><tt><font color=blue><b>set_text</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</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_Button.html#2542"><tt><font color=blue><b>set_toggle_mode</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>toggle</font></tt> = true)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Button.html#2543"><tt><font color=blue><b>set_down</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;</td> <tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_Button.html#2544"><tt><font color=blue><b>toggle</b></font></tt></a></td><td><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_Button.html#2545"><tt><font color=blue><b>set_surface_up</b></font></tt></a></td><td><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</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_Button.html#2546"><tt><font color=blue><b>set_surface_down</b></font></tt></a></td><td><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</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_Button.html#2547"><tt><font color=blue><b>set_surface_highlighted</b></font></tt></a></td><td><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</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_Button.html#2548"><tt><font color=blue><b>set_surface_disabled</b></font></tt></a></td><td><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</font></tt>)</tt>;</td> <tr valign=top><td align=left><h3>Signals:</h3></td> <tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt><font color=purple>bool</font></tt>>&</tt> </td><td align=right><a href="CL_Button.html#2549"><tt><font color=blue><b>sig_toggled</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Button.html#2550"><tt><font color=blue><b>sig_clicked</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Button.html#2551"><tt><font color=blue><b>sig_pressed</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> </td><td align=right><a href="CL_Button.html#2552"><tt><font color=blue><b>sig_released</b></font></tt></a></td><td><tt>()</tt>;</td> <tr><td> </td><tr><td colspan=3><h3>private function member index:</h3></td> <tr valign=top><td align=left><h3>Implementation:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Button.html#2553"><tt><font color=blue><b>CL_Button</b></font></tt></a></td><td><tt>(<tt>const</tt> <a href="CL_Button.html#2553"><tt><font color=blue><b>CL_Button</b></font></tt></a>& <tt><font color=blue>copy</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="2527"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2527"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2528"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2528"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2529"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2529"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2530"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2530"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Rect.html"><tt><font color=navy><b>CL_Rect</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2531"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2531"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_up</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_down</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2532"><font size=+1><b>CL_Button::CL_Button</b></font></a> - Button Constructor<br><tt></tt> <a href="CL_Button.html#2532"><tt><font color=blue><b>CL_Button</b></font></tt></a><tt>(<tt>const</tt> <a href="CL_Point.html"><tt><font color=navy><b>CL_Point</b></font></tt></a>& <tt><font color=blue>pos</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_up</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_down</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_disabled</font></tt>, <a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface_highlighted</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2540"><font size=+1><b>CL_Button::get_surface_disabled</b></font></a> - Returns the surface used when button is disabled.<br><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Button.html#2540"><tt><font color=blue><b>get_surface_disabled</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2538"><font size=+1><b>CL_Button::get_surface_down</b></font></a> - Returns the surface used when button is in the down-state.<br><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Button.html#2538"><tt><font color=blue><b>get_surface_down</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2539"><font size=+1><b>CL_Button::get_surface_highlighted</b></font></a> - Returns the surface used when button is highlighted.<br><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Button.html#2539"><tt><font color=blue><b>get_surface_highlighted</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2537"><font size=+1><b>CL_Button::get_surface_up</b></font></a> - Returns the surface used when button is in the up-state.<br><tt><a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>*</tt> <a href="CL_Button.html#2537"><tt><font color=blue><b>get_surface_up</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2534"><font size=+1><b>CL_Button::get_text</b></font></a> - Returns the button text.<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_Button.html#2534"><tt><font color=blue><b>get_text</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2536"><font size=+1><b>CL_Button::is_down</b></font></a> - Returns true if the button pressed down, or false if it is standing up. <br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Button.html#2536"><tt><font color=blue><b>is_down</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2535"><font size=+1><b>CL_Button::is_toggle_button</b></font></a> - Returns true if the button is a toggle button.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_Button.html#2535"><tt><font color=blue><b>is_toggle_button</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2543"><font size=+1><b>CL_Button::set_down</b></font></a> - Sets the state of the button to pressed down if enable is true or to standing up if enable is false. <br> The pressed(), released() and toggled() signals are not emitted by this function. <br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2543"><tt><font color=blue><b>set_down</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2548"><font size=+1><b>CL_Button::set_surface_disabled</b></font></a> - Sets the surface used when button is disabled.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2548"><tt><font color=blue><b>set_surface_disabled</b></font></tt></a><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2546"><font size=+1><b>CL_Button::set_surface_down</b></font></a> - Set the surface used when button is in the down-state.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2546"><tt><font color=blue><b>set_surface_down</b></font></tt></a><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2547"><font size=+1><b>CL_Button::set_surface_highlighted</b></font></a> - Sets the surface used when button is highlighted.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2547"><tt><font color=blue><b>set_surface_highlighted</b></font></tt></a><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2545"><font size=+1><b>CL_Button::set_surface_up</b></font></a> - Sets the surface used when button is in the up-state.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2545"><tt><font color=blue><b>set_surface_up</b></font></tt></a><tt>(<a href="CL_Surface.html"><tt><font color=navy><b>CL_Surface</b></font></tt></a>* <tt><font color=blue>surface</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2541"><font size=+1><b>CL_Button::set_text</b></font></a> - Sets the button text.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2541"><tt><font color=blue><b>set_text</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>text</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2542"><font size=+1><b>CL_Button::set_toggle_mode</b></font></a> - If toggle is true, pressing the button toggles it between an On and and Off state. <br> If toggle is false, pressing the button causes an action, then the button returns to the unpressed state. <br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2542"><tt><font color=blue><b>set_toggle_mode</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>toggle</font></tt> = true)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2550"><font size=+1><b>CL_Button::sig_clicked</b></font></a> - This signal is emitted when the button is activated (i.e. first pressed down and then released when the mouse cursor is inside the button).<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Button.html#2550"><tt><font color=blue><b>sig_clicked</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2551"><font size=+1><b>CL_Button::sig_pressed</b></font></a> - This signal is emitted when the button is pressed down. <br> In most cases, you want to use sig_clicked() instead.<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Button.html#2551"><tt><font color=blue><b>sig_pressed</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2552"><font size=+1><b>CL_Button::sig_released</b></font></a> - This signal is emitted when the button is released.<br><tt><a href="CL_Signal_v0.html"><tt><font color=navy><b>CL_Signal_v0</b></font></tt></a>&</tt> <a href="CL_Button.html#2552"><tt><font color=blue><b>sig_released</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2549"><font size=+1><b>CL_Button::sig_toggled</b></font></a> - This signal is emitted whenever a toggle button changes status.<br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt><font color=purple>bool</font></tt>>&</tt> <a href="CL_Button.html#2549"><tt><font color=blue><b>sig_toggled</b></font></tt></a><tt>()</tt>;<br><blockquote> bool on - Is true if the button is on, or false otherwise.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2544"><font size=+1><b>CL_Button::toggle</b></font></a> - Toggle the button.<br> The toggled() signal are emitted by this function.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_Button.html#2544"><tt><font color=blue><b>toggle</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="2533"><font size=+1><b>CL_Button::~CL_Button</b></font></a> - Button Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Button.html#2533"><tt><font color=blue><b>~CL_Button</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <hr noshade> </body> </html>
