<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>FXSpinner.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span> 00002 <span class="comment">* *</span> 00003 <span class="comment">* S p i n 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) 1998,2004 by Lyle Johnson. 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: FXSpinner.h,v 1.40 2004/02/08 17:17:34 fox Exp $ *</span> 00023 <span class="comment">********************************************************************************/</span> 00024 <span class="preprocessor">#ifndef FXSPINNER_H</span> 00025 <span class="preprocessor"></span><span class="preprocessor">#define FXSPINNER_H</span> 00026 <span class="preprocessor"></span> 00027 <span class="preprocessor">#ifndef FXPACKER_H</span> 00028 <span class="preprocessor"></span><span class="preprocessor">#include "FXPacker.h"</span> 00029 <span class="preprocessor">#endif</span> 00030 <span class="preprocessor"></span> 00031 <span class="keyword">namespace </span>FX { 00032 00033 00034 <span class="comment">// Spinner Options</span> 00035 <span class="keyword">enum</span> { 00036 <a class="code" href="group__FXSpinner__0.html#a0a2006">SPIN_NORMAL</a> = 0, <span class="comment">// Normal, non-cyclic</span> 00037 <a class="code" href="group__FXSpinner__0.html#a0a2007">SPIN_CYCLIC</a> = 0x00020000, <span class="comment">// Cyclic spinner</span> 00038 <a class="code" href="group__FXSpinner__0.html#a0a2008">SPIN_NOTEXT</a> = 0x00040000, <span class="comment">// No text visible</span> 00039 <a class="code" href="group__FXSpinner__0.html#a0a2009">SPIN_NOMAX</a> = 0x00080000, <span class="comment">// Spin all the way up to infinity</span> 00040 <a class="code" href="group__FXSpinner__0.html#a0a2010">SPIN_NOMIN</a> = 0x00100000 <span class="comment">// Spin all the way down to -infinity</span> 00041 }; 00042 00043 00044 <span class="keyword">class </span>FXTextField; 00045 <span class="keyword">class </span>FXArrowButton; 00046 00047 <span class="comment"></span> 00048 <span class="comment">/// Spinner control</span> 00049 <span class="comment"></span><span class="keyword">class </span>FXAPI FXSpinner : <span class="keyword">public</span> FXPacker { 00050 FXDECLARE(FXSpinner) 00051 <span class="keyword">protected</span>: 00052 FXTextField *textField; <span class="comment">// Text field</span> 00053 FXArrowButton *upButton; <span class="comment">// The up button</span> 00054 FXArrowButton *downButton; <span class="comment">// The down button</span> 00055 FXint range[2]; <span class="comment">// Reported data range</span> 00056 FXint incr; <span class="comment">// Increment</span> <a name="l00057"></a><a class="code" href="classFX_1_1FXSpinner.html">00057</a> FXint pos; <span class="comment">// Current position</span> 00058 <span class="keyword">protected</span>: 00059 FXSpinner(); 00060 <span class="keyword">private</span>: 00061 FXSpinner(<span class="keyword">const</span> FXSpinner&); 00062 FXSpinner& operator=(<span class="keyword">const</span> FXSpinner&); 00063 <span class="keyword">public</span>: 00064 <span class="keywordtype">long</span> onUpdIncrement(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00065 <span class="keywordtype">long</span> onCmdIncrement(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00066 <span class="keywordtype">long</span> onUpdDecrement(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00067 <span class="keywordtype">long</span> onCmdDecrement(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00068 <span class="keywordtype">long</span> onUpdEntry(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00069 <span class="keywordtype">long</span> onCmdEntry(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00070 <span class="keywordtype">long</span> onChgEntry(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00071 <span class="keywordtype">long</span> onWheelEntry(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00072 <span class="keywordtype">long</span> onKeyPress(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00073 <span class="keywordtype">long</span> onKeyRelease(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00074 <span class="keywordtype">long</span> onCmdSetValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00075 <span class="keywordtype">long</span> onCmdSetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00076 <span class="keywordtype">long</span> onCmdGetIntValue(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00077 <span class="keywordtype">long</span> onCmdSetIntRange(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00078 <span class="keywordtype">long</span> onCmdGetIntRange(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00079 <span class="keywordtype">long</span> onFocusSelf(<a class="code" href="classFX_1_1FXObject.html">FXObject</a>*,FXSelector,<span class="keywordtype">void</span>*); 00080 <span class="keyword">public</span>: 00081 <span class="keyword">enum</span>{ 00082 ID_INCREMENT=FXPacker::ID_LAST, 00083 ID_DECREMENT, 00084 ID_ENTRY, 00085 ID_LAST 00086 }; 00087 <span class="keyword">public</span>: 00088 <span class="comment"></span> 00089 <span class="comment"> /// Construct a spinner</span> 00090 <span class="comment"></span> FXSpinner(FXComposite *p,FXint cols,FXObject *tgt=NULL,FXSelector sel=0,FXuint opts=SPIN_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); 00091 <span class="comment"></span> 00092 <span class="comment"> /// Perform layout</span> 00093 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> layout(); 00094 <span class="comment"></span> 00095 <span class="comment"> /// Disable spinner</span> 00096 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> disable(); 00097 <span class="comment"></span> 00098 <span class="comment"> /// Enable spinner</span> 00099 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> enable(); 00100 <span class="comment"></span> 00101 <span class="comment"> /// Return default width</span> 00102 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultWidth(); 00103 <span class="comment"></span> 00104 <span class="comment"> /// Return default height</span> 00105 <span class="comment"></span> <span class="keyword">virtual</span> FXint getDefaultHeight(); 00106 <span class="comment"></span> 00107 <span class="comment"> /// Increment spinner</span> 00108 <span class="comment"></span> <span class="keywordtype">void</span> increment(); 00109 <span class="comment"></span> 00110 <span class="comment"> /// Decrement spinner</span> 00111 <span class="comment"></span> <span class="keywordtype">void</span> decrement(); 00112 <span class="comment"></span> 00113 <span class="comment"> /// Return TRUE if in cyclic mode</span> 00114 <span class="comment"></span> FXbool isCyclic() <span class="keyword">const</span>; 00115 <span class="comment"></span> 00116 <span class="comment"> /// Set to cyclic mode, i.e. wrap around at maximum/minimum</span> 00117 <span class="comment"></span> <span class="keywordtype">void</span> setCyclic(FXbool cyclic); 00118 <span class="comment"></span> 00119 <span class="comment"> /// Return TRUE if text is visible</span> 00120 <span class="comment"></span> FXbool isTextVisible() <span class="keyword">const</span>; 00121 <span class="comment"></span> 00122 <span class="comment"> /// Set text visible flag</span> 00123 <span class="comment"></span> <span class="keywordtype">void</span> setTextVisible(FXbool shown); 00124 <span class="comment"></span> <a name="l00125"></a><a class="code" href="classFX_1_1FXSpinner.html#a13">00125</a> <span class="comment"> /// Change current value</span> 00126 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setValue(FXint value); 00127 <span class="comment"></span> 00128 <span class="comment"> /// Return current value</span> 00129 <span class="comment"></span> FXint getValue()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pos; } 00130 <span class="comment"></span> <a name="l00131"></a><a class="code" href="classFX_1_1FXSpinner.html#a15">00131</a> <span class="comment"> /// Change the spinner's range</span> 00132 <span class="comment"></span> <span class="keywordtype">void</span> setRange(FXint lo,FXint hi); 00133 <span class="comment"></span> 00134 <span class="comment"> /// Get the spinner's current range</span> 00135 <span class="comment"></span> <span class="keywordtype">void</span> getRange(FXint& lo,FXint& hi)<span class="keyword"> const </span>{ lo=range[0]; hi=range[1]; } 00136 <span class="comment"></span> <a name="l00137"></a><a class="code" href="classFX_1_1FXSpinner.html#a17">00137</a> <span class="comment"> /// Change spinner increment</span> 00138 <span class="comment"></span> <span class="keywordtype">void</span> setIncrement(FXint increment); 00139 <span class="comment"></span> 00140 <span class="comment"> /// Return spinner increment</span> 00141 <span class="comment"></span> FXint getIncrement()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> incr; } 00142 <span class="comment"></span> 00143 <span class="comment"> /// Set the text font</span> 00144 <span class="comment"></span> <span class="keywordtype">void</span> setFont(FXFont *fnt); 00145 <span class="comment"></span> 00146 <span class="comment"> /// Get the text font</span> 00147 <span class="comment"></span> FXFont *getFont() <span class="keyword">const</span>; 00148 <span class="comment"></span> 00149 <span class="comment"> /// Set the status line help text for this spinner</span> 00150 <span class="comment"></span> <span class="keywordtype">void</span> setHelpText(<span class="keyword">const</span> FXString& text); 00151 <span class="comment"></span> 00152 <span class="comment"> /// Get the status line help text for this spinner</span> 00153 <span class="comment"></span> FXString getHelpText() <span class="keyword">const</span>; 00154 <span class="comment"></span> 00155 <span class="comment"> /// Set the tool tip message for this spinner</span> 00156 <span class="comment"></span> <span class="keywordtype">void</span> setTipText(<span class="keyword">const</span> FXString& text); 00157 <span class="comment"></span> 00158 <span class="comment"> /// Get the tool tip message for this spinner</span> 00159 <span class="comment"></span> FXString getTipText() <span class="keyword">const</span>; 00160 <span class="comment"></span> 00161 <span class="comment"> /// Change spinner style</span> 00162 <span class="comment"></span> <span class="keywordtype">void</span> setSpinnerStyle(FXuint style); 00163 <span class="comment"></span> 00164 <span class="comment"> /// Return current spinner style</span> 00165 <span class="comment"></span> FXuint getSpinnerStyle() <span class="keyword">const</span>; 00166 <span class="comment"></span> 00167 <span class="comment"> /// Allow editing of the text field</span> 00168 <span class="comment"></span> <span class="keywordtype">void</span> setEditable(FXbool edit=TRUE); 00169 <span class="comment"></span> 00170 <span class="comment"> /// Return TRUE if text field is editable</span> 00171 <span class="comment"></span> FXbool isEditable() <span class="keyword">const</span>; 00172 <span class="comment"></span> 00173 <span class="comment"> /// Change color of the up arrow</span> 00174 <span class="comment"></span> <span class="keywordtype">void</span> setUpArrowColor(FXColor clr); 00175 <span class="comment"></span> 00176 <span class="comment"> /// Return color of the up arrow</span> 00177 <span class="comment"></span> FXColor getUpArrowColor() <span class="keyword">const</span>; 00178 <span class="comment"></span> 00179 <span class="comment"> /// Change color of the down arrow</span> 00180 <span class="comment"></span> <span class="keywordtype">void</span> setDownArrowColor(FXColor clr); 00181 <span class="comment"></span> 00182 <span class="comment"> /// Return color of the the down arrow</span> 00183 <span class="comment"></span> FXColor getDownArrowColor() <span class="keyword">const</span>; 00184 <span class="comment"></span> 00185 <span class="comment"> /// Change text color</span> 00186 <span class="comment"></span> <span class="keywordtype">void</span> setTextColor(FXColor clr); 00187 <span class="comment"></span> 00188 <span class="comment"> /// Return text color</span> 00189 <span class="comment"></span> FXColor getTextColor() <span class="keyword">const</span>; 00190 <span class="comment"></span> 00191 <span class="comment"> /// Change selected background color</span> 00192 <span class="comment"></span> <span class="keywordtype">void</span> setSelBackColor(FXColor clr); 00193 <span class="comment"></span> 00194 <span class="comment"> /// Return selected background color</span> 00195 <span class="comment"></span> FXColor getSelBackColor() <span class="keyword">const</span>; 00196 <span class="comment"></span> 00197 <span class="comment"> /// Change selected text color</span> 00198 <span class="comment"></span> <span class="keywordtype">void</span> setSelTextColor(FXColor clr); 00199 <span class="comment"></span> 00200 <span class="comment"> /// Return selected text color</span> 00201 <span class="comment"></span> FXColor getSelTextColor() <span class="keyword">const</span>; 00202 <span class="comment"></span> 00203 <span class="comment"> /// Changes the cursor color</span> 00204 <span class="comment"></span> <span class="keywordtype">void</span> setCursorColor(FXColor clr); 00205 <span class="comment"></span> 00206 <span class="comment"> /// Return the cursor color</span> 00207 <span class="comment"></span> FXColor getCursorColor() <span class="keyword">const</span>; 00208 <span class="comment"></span> 00209 <span class="comment"> /// Change width of text field in terms of number of columns * `m'</span> 00210 <span class="comment"></span> <span class="keywordtype">void</span> setNumColumns(FXint cols); 00211 <span class="comment"></span> 00212 <span class="comment"> /// Return number of columns</span> 00213 <span class="comment"></span> FXint getNumColumns() <span class="keyword">const</span>; 00214 <span class="comment"></span> 00215 <span class="comment"> /// Save spinner to a stream</span> 00216 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(FXStream& store) <span class="keyword">const</span>; 00217 <span class="comment"></span> 00218 <span class="comment"> /// Load spinner from a stream</span> 00219 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(FXStream& store); 00220 <span class="comment"></span> 00221 <span class="comment"> /// Destructor</span> 00222 <span class="comment"></span> <span class="keyword">virtual</span> ~FXSpinner(); 00223 }; 00224 00225 } 00226 00227 <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>