fox-toolkit.org - Documentation

00001 /******************************************************************************** 00002 * * 00003 * R e a l - V a l u e d S p i n n e r W i d g e t * 00004 * * 00005 ********************************************************************************* 00006 * Copyright (C) 2003,2004 by Bill Baxter. All Rights Reserved. * 00007 ********************************************************************************* 00008 * This library is free software; you can redistribute it and/or * 00009 * modify it under the terms of the GNU Lesser General Public * 00010 * License as published by the Free Software Foundation; either * 00011 * version 2.1 of the License, or (at your option) any later version. * 00012 * * 00013 * This library is distributed in the hope that it will be useful, * 00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * 00016 * Lesser General Public License for more details. * 00017 * * 00018 * You should have received a copy of the GNU Lesser General Public * 00019 * License along with this library; if not, write to the Free Software * 00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. * 00021 ********************************************************************************* 00022 * $Id: FXRealSpinner.h,v 1.9 2004/02/08 17:17:34 fox Exp $ * 00023 ********************************************************************************/ 00024 #ifndef FXREALSPINNER_H 00025 #define FXREALSPINNER_H 00026 00027 #ifndef FXPACKER_H 00028 #include "FXPacker.h" 00029 #endif 00030 00031 namespace FX { 00032 00033 00034 // Spinner Options 00035 enum { 00036 REALSPIN_NORMAL = 0, // Normal, non-cyclic 00037 REALSPIN_CYCLIC = 0x00020000, // Cyclic spinner 00038 REALSPIN_NOTEXT = 0x00040000, // No text visible 00039 REALSPIN_NOMAX = 0x00080000, // Spin all the way up to infinity 00040 REALSPIN_NOMIN = 0x00100000, // Spin all the way down to -infinity 00041 REALSPIN_LOG = 0x00200000 // Logarithmic rather than linear 00042 }; 00043 00044 00045 class FXTextField; 00046 class FXDial; 00047 00048 00049 /// Spinner control 00050 class FXAPI FXRealSpinner : public FXPacker { 00051 FXDECLARE(FXRealSpinner) 00052 protected: 00053 FXTextField *textField; // Text field 00054 FXArrowButton *upButton; // The up button 00055 FXArrowButton *downButton; // The down button 00056 FXdouble range[2]; // Reported data range 00057 FXdouble base; // Base while incrementing 00058 FXdouble incr; // Increment 00059 FXdouble pos; // Current position 00060 FXint ticks; // Ticks incrementing 00061 protected: 00062 FXRealSpinner(); 00063 private: 00064 FXRealSpinner(const FXRealSpinner&); 00065 FXRealSpinner& operator=(const FXRealSpinner&); 00066 public: 00067 long onUpdIncrement(FXObject*,FXSelector,void*); 00068 long onCmdIncrement(FXObject*,FXSelector,void*); 00069 long onUpdDecrement(FXObject*,FXSelector,void*); 00070 long onCmdDecrement(FXObject*,FXSelector,void*); 00071 long onUpdEntry(FXObject*,FXSelector,void*); 00072 long onCmdEntry(FXObject*,FXSelector,void*); 00073 long onChgEntry(FXObject*,FXSelector,void*); 00074 long onWheelEntry(FXObject*,FXSelector,void*); 00075 long onKeyPress(FXObject*,FXSelector,void*); 00076 long onKeyRelease(FXObject*,FXSelector,void*); 00077 long onCmdSetValue(FXObject*,FXSelector,void*); 00078 long onCmdSetIntValue(FXObject*,FXSelector,void*); 00079 long onCmdGetIntValue(FXObject*,FXSelector,void*); 00080 long onCmdSetIntRange(FXObject*,FXSelector,void*); 00081 long onCmdGetIntRange(FXObject*,FXSelector,void*); 00082 long onCmdSetRealValue(FXObject*,FXSelector,void*); 00083 long onCmdGetRealValue(FXObject*,FXSelector,void*); 00084 long onCmdSetRealRange(FXObject*,FXSelector,void*); 00085 long onCmdGetRealRange(FXObject*,FXSelector,void*); 00086 long onFocusSelf(FXObject*,FXSelector,void*); 00087 public: 00088 enum{ 00089 ID_INCREMENT=FXPacker::ID_LAST, 00090 ID_DECREMENT, 00091 ID_ENTRY, 00092 ID_LAST 00093 }; 00094 public: 00095 00096 /// Construct a spinner 00097 FXRealSpinner(FXComposite *p,FXint cols,FXObject *tgt=NULL,FXSelector sel=0,FXuint opts=REALSPIN_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); 00098 00099 /// Perform layout 00100 virtual void layout(); 00101 00102 /// Disable spinner 00103 virtual void disable(); 00104 00105 /// Enable spinner 00106 virtual void enable(); 00107 00108 /// Return default width 00109 virtual FXint getDefaultWidth(); 00110 00111 /// Return default height 00112 virtual FXint getDefaultHeight(); 00113 00114 /// Increment spinner 00115 void increment(); 00116 00117 /// Decrement spinner 00118 void decrement(); 00119 00120 /// Return TRUE if in cyclic mode 00121 FXbool isCyclic() const; 00122 00123 /// Set to cyclic mode, i.e. wrap around at maximum/minimum 00124 void setCyclic(FXbool cyclic); 00125 00126 /// Return TRUE if text is visible 00127 FXbool isTextVisible() const; 00128 00129 /// Set text visible flag 00130 void setTextVisible(FXbool shown); 00131 00132 /// Change current value 00133 virtual void setValue(FXdouble value); 00134 00135 /// Return current value 00136 FXdouble getValue() const { return pos; } 00137 00138 /// Change the spinner's range 00139 void setRange(FXdouble lo,FXdouble hi); 00140 00141 /// Get the spinner's current range 00142 void getRange(FXdouble& lo,FXdouble& hi) const { lo=range[0]; hi=range[1]; } 00143 00144 /// Change spinner increment 00145 void setIncrement(FXdouble increment); 00146 00147 /// Return spinner increment 00148 FXdouble getIncrement() const { return incr; } 00149 00150 /// Set the text font 00151 void setFont(FXFont *fnt); 00152 00153 /// Get the text font 00154 FXFont *getFont() const; 00155 00156 /// Set the status line help text for this spinner 00157 void setHelpText(const FXString& text); 00158 00159 /// Get the status line help text for this spinner 00160 FXString getHelpText() const; 00161 00162 /// Set the tool tip message for this spinner 00163 void setTipText(const FXString& text); 00164 00165 /// Get the tool tip message for this spinner 00166 FXString getTipText() const; 00167 00168 /// Change spinner style 00169 void setSpinnerStyle(FXuint style); 00170 00171 /// Return current spinner style 00172 FXuint getSpinnerStyle() const; 00173 00174 /// Allow editing of the text field 00175 void setEditable(FXbool edit=TRUE); 00176 00177 /// Return TRUE if text field is editable 00178 FXbool isEditable() const; 00179 00180 /// Change color of the up arrow 00181 void setUpArrowColor(FXColor clr); 00182 00183 /// Return color of the up arrow 00184 FXColor getUpArrowColor() const; 00185 00186 /// Change color of the down arrow 00187 void setDownArrowColor(FXColor clr); 00188 00189 /// Return color of the the down arrow 00190 FXColor getDownArrowColor() const; 00191 00192 /// Change text color 00193 void setTextColor(FXColor clr); 00194 00195 /// Return text color 00196 FXColor getTextColor() const; 00197 00198 /// Change selected background color 00199 void setSelBackColor(FXColor clr); 00200 00201 /// Return selected background color 00202 FXColor getSelBackColor() const; 00203 00204 /// Change selected text color 00205 void setSelTextColor(FXColor clr); 00206 00207 /// Return selected text color 00208 FXColor getSelTextColor() const; 00209 00210 /// Changes the cursor color 00211 void setCursorColor(FXColor clr); 00212 00213 /// Return the cursor color 00214 FXColor getCursorColor() const; 00215 00216 /// Change width of text field in terms of number of columns * `m' 00217 void setNumColumns(FXint cols); 00218 00219 /// Return number of columns 00220 FXint getNumColumns() const; 00221 00222 /// Save spinner to a stream 00223 virtual void save(FXStream& store) const; 00224 00225 /// Load spinner from a stream 00226 virtual void load(FXStream& store); 00227 00228 /// Destructor 00229 virtual ~FXRealSpinner(); 00230 }; 00231 00232 } 00233 00234 #endif