blob: 501672eac2e34b50eb4b67bb862d5049a6f61b5f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Skia: SkButtonWidget Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SkButtonWidget Class Reference</h1><!-- doxytag: class="SkButtonWidget" --><!-- doxytag: inherits="SkHasLabelWidget" -->
<p><code>#include &lt;<a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_sk_has_label_widget.html">SkHasLabelWidget</a>.</p>
<p>Inherited by <a class="el" href="class_sk_check_box_widget.html">SkCheckBoxWidget</a>, and <a class="el" href="class_sk_push_button_widget.html">SkPushButtonWidget</a>.</p>
<div class="dynheader">
Collaboration diagram for SkButtonWidget:</div>
<div class="dynsection">
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_sk_button_widget-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">State</a> { <a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909ac1cd8734c0fa93352ddbd99ea176acf2">kOff_State</a>,
<a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909ad26d12833af6fac4e46ea7ffb9421c48">kOn_State</a>,
<a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909aa1352e9e8225cc24c5a91658a5e85f6f">kUnknown_State</a>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#a4b431e1bc6f710a71a9e9573c623868f">SkButtonWidget</a> (uint32_t flags=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">State</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#a5e2738c43f7844af9784507e37a53c25">getButtonState</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#a4d3c3e719c6859aeea2352a5c6801943">setButtonState</a> (<a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">State</a>)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#a0a767ef65346e380be639a3f8d27cb4b">onButtonStateChange</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_button_widget.html#ad113cabe5eb13d9f713b4d7641300239">onInflate</a> (const <a class="el" href="class_sk_d_o_m.html">SkDOM</a> &amp;dom, const <a class="el" href="class_sk_d_o_m.html#a80efdeca8b3516a1216b4c5b37abddce">SkDOM::Node</a> *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_sk_widget_8h_source.html#l00073">73</a> of file <a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="af213c9ee5b5a3fc3c0dba5e6e6559909"></a><!-- doxytag: member="SkButtonWidget::State" ref="af213c9ee5b5a3fc3c0dba5e6e6559909" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">SkButtonWidget::State</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="af213c9ee5b5a3fc3c0dba5e6e6559909ac1cd8734c0fa93352ddbd99ea176acf2"></a><!-- doxytag: member="kOff_State" ref="af213c9ee5b5a3fc3c0dba5e6e6559909ac1cd8734c0fa93352ddbd99ea176acf2" args="" -->kOff_State</em>&nbsp;</td><td>
<p>XML: buttonState="off". </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af213c9ee5b5a3fc3c0dba5e6e6559909ad26d12833af6fac4e46ea7ffb9421c48"></a><!-- doxytag: member="kOn_State" ref="af213c9ee5b5a3fc3c0dba5e6e6559909ad26d12833af6fac4e46ea7ffb9421c48" args="" -->kOn_State</em>&nbsp;</td><td>
<p>XML: buttonState="on". </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af213c9ee5b5a3fc3c0dba5e6e6559909aa1352e9e8225cc24c5a91658a5e85f6f"></a><!-- doxytag: member="kUnknown_State" ref="af213c9ee5b5a3fc3c0dba5e6e6559909aa1352e9e8225cc24c5a91658a5e85f6f" args="" -->kUnknown_State</em>&nbsp;</td><td>
<p>XML: buttonState="unknown". </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sk_widget_8h_source.html#l00077">77</a> of file <a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4b431e1bc6f710a71a9e9573c623868f"></a><!-- doxytag: member="SkButtonWidget::SkButtonWidget" ref="a4b431e1bc6f710a71a9e9573c623868f" args="(uint32_t flags=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkButtonWidget::SkButtonWidget </td>
<td>(</td>
<td class="paramtype">uint32_t&nbsp;</td>
<td class="paramname"> <em>flags</em> = <code>0</code></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_widget_8h_source.html#l00075">75</a> of file <a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5e2738c43f7844af9784507e37a53c25"></a><!-- doxytag: member="SkButtonWidget::getButtonState" ref="a5e2738c43f7844af9784507e37a53c25" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">State</a> SkButtonWidget::getButtonState </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_widget_8h_source.html#l00082">82</a> of file <a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0a767ef65346e380be639a3f8d27cb4b"></a><!-- doxytag: member="SkButtonWidget::onButtonStateChange" ref="a0a767ef65346e380be639a3f8d27cb4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SkButtonWidget::onButtonStateChange </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>called when the label changes. default behavior is to inval the widget </p>
</div>
</div>
<a class="anchor" id="ad113cabe5eb13d9f713b4d7641300239"></a><!-- doxytag: member="SkButtonWidget::onInflate" ref="ad113cabe5eb13d9f713b4d7641300239" args="(const SkDOM &amp;dom, const SkDOM::Node *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SkButtonWidget::onInflate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_sk_d_o_m.html">SkDOM</a> &amp;&nbsp;</td>
<td class="paramname"> <em>dom</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_d_o_m.html#a80efdeca8b3516a1216b4c5b37abddce">SkDOM::Node</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this to initialize your subclass from the XML node. Be sure to call the inherited version too </p>
<p>Reimplemented from <a class="el" href="class_sk_has_label_widget.html#aee6a0ad820525122a7b341269c2d3531">SkHasLabelWidget</a>.</p>
<p>Reimplemented in <a class="el" href="class_sk_check_box_widget.html#a919a2cd9aa7a3f74d8314fc413a2d50d">SkCheckBoxWidget</a>.</p>
</div>
</div>
<a class="anchor" id="a4d3c3e719c6859aeea2352a5c6801943"></a><!-- doxytag: member="SkButtonWidget::setButtonState" ref="a4d3c3e719c6859aeea2352a5c6801943" args="(State)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SkButtonWidget::setButtonState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_button_widget.html#af213c9ee5b5a3fc3c0dba5e6e6559909">State</a>&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Volumes/disk/skia/trunk/include/views/<a class="el" href="_sk_widget_8h_source.html">SkWidget.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Oct 20 10:33:03 2009 for Skia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>