<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>FXTriStateButton.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span>
00002 <span class="comment">* *</span>
00003 <span class="comment">* T r i - S t a t e B u t t o n W i d g e t *</span>
00004 <span class="comment">* *</span>
00005 <span class="comment">*********************************************************************************</span>
00006 <span class="comment">* Copyright (C) 2002,2004 by Charles Warren. All Rights Reserved. *</span>
00007 <span class="comment">*********************************************************************************</span>
00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span>
00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span>
00010 <span class="comment">* License as published by the Free Software Foundation; either *</span>
00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span>
00012 <span class="comment">* *</span>
00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span>
00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span>
00016 <span class="comment">* Lesser General Public License for more details. *</span>
00017 <span class="comment">* *</span>
00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span>
00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span>
00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span>
00021 <span class="comment">*********************************************************************************</span>
00022 <span class="comment">* $Id: FXTriStateButton.h,v 1.4 2004/02/08 17:17:34 fox Exp $ *</span>
00023 <span class="comment">********************************************************************************/</span>
00024 <span class="preprocessor">#ifndef FXTRISTATEBUTTON_H</span>
00025 <span class="preprocessor"></span><span class="preprocessor">#define FXTRISTATEBUTTON_H</span>
00026 <span class="preprocessor"></span>
00027 <span class="preprocessor">#ifndef FXTOGGLEBUTTON_H</span>
00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXToggleButton.h"</span>
00029 <span class="preprocessor">#endif</span>
00030 <span class="preprocessor"></span>
00031
00032 <span class="keyword">namespace </span>FX {
00033 <span class="comment"></span>
00034 <span class="comment">/**</span>
00035 <span class="comment">* The tri-state button provides a three-state button, which toggles between the</span>
00036 <span class="comment">* on and the off state each time it is pressed; programmatically, it may also be</span>
00037 <span class="comment">* switched into the MAYBE state. The MAYBE state is useful to signify an unknown</span>
00038 <span class="comment">* state in the application data.</span>
00039 <span class="comment">* Like the toggle button, it sends a SEL_COMMAND to its target, with the</span>
00040 <span class="comment">* message data set to the current state of the toggle button, of the type FXbool.</span>
00041 <span class="comment">*/</span>
<a name="l00042"></a><a class="code" href="classFX_1_1FXTriStateButton.html">00042</a> <span class="keyword">class </span>FXAPI FXTriStateButton : <span class="keyword">public</span> <a class="code" href="classFX_1_1FXToggleButton.html">FXToggleButton</a> {
00043 FXDECLARE(FXTriStateButton)
00044 <span class="keyword">protected</span>:
00045 <a class="code" href="classFX_1_1FXString.html">FXString</a> maybelabel;
00046 <a class="code" href="classFX_1_1FXIcon.html">FXIcon</a> *maybeicon;
00047 <a class="code" href="classFX_1_1FXString.html">FXString</a> maybetip;
00048 <a class="code" href="classFX_1_1FXString.html">FXString</a> maybehelp;
00049 <span class="keyword">protected</span>:
00050 FXTriStateButton();
00051 <span class="keyword">private</span>:
00052 FXTriStateButton(<span class="keyword">const</span> FXTriStateButton&);
00053 FXTriStateButton& operator=(<span class="keyword">const</span> FXTriStateButton&);
00054 <span class="keyword">public</span>:
00055 <span class="keywordtype">long</span> onPaint(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00056 <span class="keywordtype">long</span> onUnknown(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00057 <span class="keywordtype">long</span> onQueryHelp(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00058 <span class="keywordtype">long</span> onQueryTip(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*);
00059 <span class="keyword">public</span>:
00060 <span class="comment"></span>
00061 <span class="comment"> /// Construct tri-state toggle button with three text labels, and three icons, one for each state</span>
00062 <span class="comment"></span> FXTriStateButton(<a class="code" href="classFX_1_1FXComposite.html">FXComposite</a>* p,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text1,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text2,<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text3,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* icon1=NULL,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* icon2=NULL,<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* icon3=NULL,<a class="code" href="classFX_1_1FXObject.html">FXObject</a>* tgt=NULL,FXSelector sel=0,FXuint opts=TOGGLEBUTTON_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);
00063 <span class="comment"></span>
00064 <span class="comment"> /// Create server-side resources</span>
00065 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> create();
00066 <span class="comment"></span>
00067 <span class="comment"> /// Detach server-side resources</span>
00068 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach();
00069 <span class="comment"></span>
<a name="l00070"></a><a class="code" href="classFX_1_1FXTriStateButton.html#a6">00070</a> <span class="comment"> /// Get default width</span>
00071 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth();
00072 <span class="comment"></span>
00073 <span class="comment"> /// Get default height</span>
00074 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight();
00075 <span class="comment"></span>
<a name="l00076"></a><a class="code" href="classFX_1_1FXTriStateButton.html#a8">00076</a> <span class="comment"> /// Change maybe text shown when toggled</span>
00077 <span class="comment"></span> <span class="keywordtype">void</span> setMaybeText(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text);
00078 <span class="comment"></span>
00079 <span class="comment"> /// Return maybe text</span>
00080 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getMaybeText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> maybelabel; }
00081 <span class="comment"></span>
<a name="l00082"></a><a class="code" href="classFX_1_1FXTriStateButton.html#a10">00082</a> <span class="comment"> /// Change maybe icon shown when toggled</span>
00083 <span class="comment"></span> <span class="keywordtype">void</span> setMaybeIcon(<a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* ic);
00084 <span class="comment"></span>
00085 <span class="comment"> /// Return maybe icon</span>
00086 <span class="comment"></span> <a class="code" href="classFX_1_1FXIcon.html">FXIcon</a>* getMaybeIcon()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> maybeicon; }
00087 <span class="comment"></span>
<a name="l00088"></a><a class="code" href="classFX_1_1FXTriStateButton.html#a12">00088</a> <span class="comment"> /// Change maybe help text shown when toggled</span>
00089 <span class="comment"></span> <span class="keywordtype">void</span> setMaybeHelpText(<span class="keyword">const</span> <a class="code" href="classFX_1_1FXString.html">FXString</a>& text);
00090 <span class="comment"></span>
00091 <span class="comment"> /// Return maybe help text</span>
00092 <span class="comment"></span> <a class="code" href="classFX_1_1FXString.html">FXString</a> getMaybeHelpText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> maybehelp; }
00093 <span class="comment"></span>
00094 <span class="comment"> /// Change maybe tip text shown when toggled</span>
00095 <span class="comment"></span> <span class="keywordtype">void</span> setMaybeTipText(<span class="keyword">const</span> FXString& text);
00096 <span class="comment"></span>
00097 <span class="comment"> /// Return maybe tip text</span>
00098 <span class="comment"></span> FXString getMaybeTipText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> maybetip; }
00099 <span class="comment"></span>
00100 <span class="comment"> /// Save toggle button to a stream</span>
00101 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>;
00102 <span class="comment"></span>
00103 <span class="comment"> /// Load toggle button from a stream</span>
00104 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store);
00105 <span class="comment"></span>
00106 <span class="comment"> /// Destructor</span>
00107 <span class="comment"></span> <span class="keyword">virtual</span> ~FXTriStateButton();
00108 };
00109
00110 }
00111
00112 <span class="preprocessor">#endif</span>
</pre></div></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>
