<html> <head> <link rel="stylesheet" href="page.css" type="text/css"> <title>fox-toolkit.org - Documentation</title> </head> <body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000> <font face='verdana,sans-serif' size=2 > <!---- TOPIC TITLE WITH LOGO---> <table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table> <p> <!--- TOPIC TITLE WITH LOGO ---> <!-- Generated by Doxygen 1.3.3 --> <h1>FX::FXCheckButton Class Reference</h1>A check button is a tri-state button. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="FXCheckButton_8h-source.html">FXCheckButton.h</a>></code> <p> <p>Inheritance diagram for FX::FXCheckButton: <p><center><img src="classFX_1_1FXCheckButton.png" usemap="#FX::FXCheckButton_map" border="0" alt=""></center> <map name="FX::FXCheckButton_map"> <area href="classFX_1_1FXLabel.html" alt="FX::FXLabel" shape="rect" coords="0,280,123,304"> <area href="classFX_1_1FXFrame.html" alt="FX::FXFrame" shape="rect" coords="0,224,123,248"> <area href="classFX_1_1FXWindow.html" alt="FX::FXWindow" shape="rect" coords="0,168,123,192"> <area href="classFX_1_1FXDrawable.html" alt="FX::FXDrawable" shape="rect" coords="0,112,123,136"> <area href="classFX_1_1FXId.html" alt="FX::FXId" shape="rect" coords="0,56,123,80"> <area href="classFX_1_1FXObject.html" alt="FX::FXObject" shape="rect" coords="0,0,123,24"> </map> <a href="classFX_1_1FXCheckButton-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="classFX_1_1FXCheckButton.html#a0">FXCheckButton</a> (<a class="el" href="classFX_1_1FXComposite.html">FXComposite</a> *p, const <a class="el" href="classFX_1_1FXString.html">FXString</a> &text, <a class="el" href="classFX_1_1FXObject.html">FXObject</a> *tgt=NULL, FXSelector sel=0, FXuint opts=CHECKBUTTON_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXbool </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a1">canFocus</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a2">getDefaultWidth</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual FXint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a3">getDefaultHeight</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a4">setCheck</a> (FXbool state=TRUE)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXbool </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a5">getCheck</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a6">setCheckButtonStyle</a> (FXuint style)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXuint </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a7">getCheckButtonStyle</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>FXColor </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a8">getBoxColor</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a9">setBoxColor</a> (FXColor clr)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a10">save</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store) const</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classFX_1_1FXCheckButton.html#a11">load</a> (<a class="el" href="classFX_1_1FXStream.html">FXStream</a> &store)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A check button is a tri-state button. <p> Normally, it is either TRUE or FALSE, and toggles between TRUE or FALSE whenever it is pressed. A third state MAYBE may be set to indicate that no selection has been made yet by the user, or that the state is ambiguous. When pressed, the check button sends a SEL_COMMAND to its target, and the message data represents the state of the check button.<p> See also: <ul> <li><a class="el" href="group__FXCheckButton__0.html">CheckButton styles</a>. </li> </ul> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="FX::FXCheckButton::FXCheckButton"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FX::FXCheckButton::FXCheckButton </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXComposite.html">FXComposite</a> * </td> <td class="mdname" nowrap> <em>p</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classFX_1_1FXString.html">FXString</a> & </td> <td class="mdname" nowrap> <em>text</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classFX_1_1FXObject.html">FXObject</a> * </td> <td class="mdname" nowrap> <em>tgt</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXSelector </td> <td class="mdname" nowrap> <em>sel</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXuint </td> <td class="mdname" nowrap> <em>opts</em> = CHECKBUTTON_NORMAL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>x</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>y</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>w</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>h</em> = 0, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>pl</em> = DEFAULT_PAD, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>pr</em> = DEFAULT_PAD, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>pt</em> = DEFAULT_PAD, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>FXint </td> <td class="mdname" nowrap> <em>pb</em> = DEFAULT_PAD</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Construct new check button. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a1" doxytag="FX::FXCheckButton::canFocus"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual FXbool FX::FXCheckButton::canFocus </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Returns true because a check button can receive focus. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXWindow.html#a50">FX::FXWindow</a>. </td> </tr> </table> <a name="a2" doxytag="FX::FXCheckButton::getDefaultWidth"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual FXint FX::FXCheckButton::getDefaultWidth </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get default width. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXLabel.html#a5">FX::FXLabel</a>. </td> </tr> </table> <a name="a3" doxytag="FX::FXCheckButton::getDefaultHeight"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual FXint FX::FXCheckButton::getDefaultHeight </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get default height. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXLabel.html#a6">FX::FXLabel</a>. </td> </tr> </table> <a name="a4" doxytag="FX::FXCheckButton::setCheck"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXCheckButton::setCheck </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXbool </td> <td class="mdname1" valign="top" nowrap> <em>state</em> = TRUE </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set check button state (TRUE, FALSE or MAYBE). <p> </td> </tr> </table> <a name="a5" doxytag="FX::FXCheckButton::getCheck"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXbool FX::FXCheckButton::getCheck </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get check button state (TRUE, FALSE or MAYBE). <p> </td> </tr> </table> <a name="a6" doxytag="FX::FXCheckButton::setCheckButtonStyle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXCheckButton::setCheckButtonStyle </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXuint </td> <td class="mdname1" valign="top" nowrap> <em>style</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Change check button style. <p> </td> </tr> </table> <a name="a7" doxytag="FX::FXCheckButton::getCheckButtonStyle"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXuint FX::FXCheckButton::getCheckButtonStyle </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Return current check button style. <p> </td> </tr> </table> <a name="a8" doxytag="FX::FXCheckButton::getBoxColor"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> FXColor FX::FXCheckButton::getBoxColor </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Get the box background color. <p> </td> </tr> </table> <a name="a9" doxytag="FX::FXCheckButton::setBoxColor"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void FX::FXCheckButton::setBoxColor </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">FXColor </td> <td class="mdname1" valign="top" nowrap> <em>clr</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Set the box background color. <p> </td> </tr> </table> <a name="a10" doxytag="FX::FXCheckButton::save"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void FX::FXCheckButton::save </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td> <td class="mdname1" valign="top" nowrap> <em>store</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Save check button to a stream. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXLabel.html#a23">FX::FXLabel</a>. </td> </tr> </table> <a name="a11" doxytag="FX::FXCheckButton::load"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void FX::FXCheckButton::load </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classFX_1_1FXStream.html">FXStream</a> & </td> <td class="mdname1" valign="top" nowrap> <em>store</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Load check button from a stream. <p> <p> Reimplemented from <a class="el" href="classFX_1_1FXLabel.html#a24">FX::FXLabel</a>. </td> </tr> </table> </font> <!--- COPYRIGHT --> <p> <table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right> <img src='../art/line.gif' width=100% height=1><font size=-1> Copyright © 1997-2004 Jeroen van der Zijp</font> </td></tr></table> </p> <!--- COPYRIGHT --> </body> </html>