Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXSpinner.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                        S p i n   B u t t o n   W i d g e t                    *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1998,2009 by Lyle Johnson.   All Rights Reserved.               *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or modify          *
00009 * it under the terms of the GNU Lesser General Public License as published by   *
00010 * the Free Software Foundation; either version 3 of the License, or             *
00011 * (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                 *
00016 * GNU Lesser General Public License for more details.                           *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public License      *
00019 * along with this program.  If not, see <http://www.gnu.org/licenses/>          *
00020 *********************************************************************************
00021 * $Id: FXSpinner.h,v 1.56 2009/01/06 13:07:27 fox Exp $                         *
00022 ********************************************************************************/
00023 #ifndef FXSPINNER_H
00024 #define FXSPINNER_H
00025 
00026 #ifndef FXPACKER_H
00027 #include "FXPacker.h"
00028 #endif
00029 
00030 namespace FX {
00031 
00032 
00033 /// Spinner Options
00034 enum {
00035   SPIN_NORMAL  =  0,                /// Normal, non-cyclic
00036   SPIN_CYCLIC  =  0x00020000,       /// Cyclic spinner
00037   SPIN_NOTEXT  =  0x00040000,       /// No text visible
00038   SPIN_NOMAX   =  0x00080000,       /// Spin all the way up to infinity
00039   SPIN_NOMIN   =  0x00100000        /// Spin all the way down to -infinity
00040   };
00041 
00042 
00043 class FXTextField;
00044 class FXArrowButton;
00045 
00046 
00047 /// Spinner control
00048 class FXAPI FXSpinner : public FXPacker {
00049   FXDECLARE(FXSpinner)
00050 protected:
00051   FXTextField   *textField;         // Text field
00052   FXArrowButton *upButton;          // The up button
00053   FXArrowButton *downButton;        // The down button
00054   FXint          range[2];          // Reported data range
00055   FXint          incr;              // Increment
00056   FXint          pos;               // Current position
00057 protected:
00058   FXSpinner();
00059 private:
00060   FXSpinner(const FXSpinner&);
00061   FXSpinner& operator=(const FXSpinner&);
00062 public:
00063   long onUpdIncrement(FXObject*,FXSelector,void*);
00064   long onCmdIncrement(FXObject*,FXSelector,void*);
00065   long onUpdDecrement(FXObject*,FXSelector,void*);
00066   long onCmdDecrement(FXObject*,FXSelector,void*);
00067   long onUpdEntry(FXObject*,FXSelector,void*);
00068   long onChgEntry(FXObject*,FXSelector,void*);
00069   long onCmdEntry(FXObject*,FXSelector,void*);
00070   long onWheelEntry(FXObject*,FXSelector,void*);
00071   long onKeyPress(FXObject*,FXSelector,void*);
00072   long onKeyRelease(FXObject*,FXSelector,void*);
00073   long onCmdSetValue(FXObject*,FXSelector,void*);
00074   long onCmdSetIntValue(FXObject*,FXSelector,void*);
00075   long onCmdGetIntValue(FXObject*,FXSelector,void*);
00076   long onCmdSetLongValue(FXObject*,FXSelector,void*);
00077   long onCmdGetLongValue(FXObject*,FXSelector,void*);
00078   long onCmdSetIntRange(FXObject*,FXSelector,void*);
00079   long onCmdGetIntRange(FXObject*,FXSelector,void*);
00080   long onFocusSelf(FXObject*,FXSelector,void*);
00081 public:
00082   enum{
00083     ID_INCREMENT=FXPacker::ID_LAST,
00084     ID_DECREMENT,
00085     ID_ENTRY,
00086     ID_LAST
00087     };
00088 public:
00089 
00090   /// Construct a spinner
00091   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);
00092 
00093   /// Perform layout
00094   virtual void layout();
00095 
00096   /// Disable spinner
00097   virtual void disable();
00098 
00099   /// Enable spinner
00100   virtual void enable();
00101 
00102   /// Return default width
00103   virtual FXint getDefaultWidth();
00104 
00105   /// Return default height
00106   virtual FXint getDefaultHeight();
00107 
00108   /// Increment spinner
00109   void increment(FXbool notify=false);
00110 
00111   /// Increment spinner by certain amount
00112   void incrementByAmount(FXint amount,FXbool notify=false);
00113 
00114   /// Decrement spinner
00115   void decrement(FXbool notify=false);
00116 
00117   /// Decrement spinner by certain amount
00118   void decrementByAmount(FXint amount,FXbool notify=false);
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 flag);
00131 
00132   /// Change current value
00133   virtual void setValue(FXint value,FXbool notify=false);
00134 
00135   /// Return current value
00136   FXint getValue() const { return pos; }
00137 
00138   /// Change the spinner's range
00139   void setRange(FXint lo,FXint hi,FXbool notify=false);
00140 
00141   /// Get the spinner's current range
00142   void getRange(FXint& lo,FXint& hi) const { lo=range[0]; hi=range[1]; }
00143 
00144   /// Change spinner increment
00145   void setIncrement(FXint increment);
00146 
00147   /// Return spinner increment
00148   FXint 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   const 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   const 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 ~FXSpinner();
00230   };
00231 
00232 }
00233 
00234 #endif

Copyright © 1997-2009 Jeroen van der Zijp