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

FXSlider.h

00001 /********************************************************************************
00002 *                                                                               *
00003 *                           S l i d e r   W i d g e t                           *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1997,2002 by Jeroen van der Zijp.   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: FXSlider.h,v 1.25 2002/01/18 22:42:54 jeroen Exp $                       *
00023 ********************************************************************************/
00024 #ifndef FXSLIDER_H
00025 #define FXSLIDER_H
00026 
00027 #ifndef FXFRAME_H
00028 #include "FXFrame.h"
00029 #endif
00030 
00031 
00032 struct FXTimer;
00033 
00034 
00035 /// Slider Control styles
00036 enum {
00037   SLIDER_HORIZONTAL   = 0,                        /// Slider shown horizontally
00038   SLIDER_VERTICAL     = 0x00008000,               /// Slider shown vertically
00039   SLIDER_ARROW_UP     = 0x00010000,               /// Slider has arrow head pointing up
00040   SLIDER_ARROW_DOWN   = 0x00020000,               /// Slider has arrow head pointing down
00041   SLIDER_ARROW_LEFT   = SLIDER_ARROW_UP,          /// Slider has arrow head pointing left
00042   SLIDER_ARROW_RIGHT  = SLIDER_ARROW_DOWN,        /// Slider has arrow head pointing right
00043   SLIDER_INSIDE_BAR   = 0x00040000,               /// Slider is inside the slot rather than overhanging
00044   SLIDER_TICKS_TOP    = 0x00080000,               /// Ticks on the top of horizontal slider
00045   SLIDER_TICKS_BOTTOM = 0x00100000,               /// Ticks on the bottom of horizontal slider
00046   SLIDER_TICKS_LEFT   = SLIDER_TICKS_TOP,         /// Ticks on the left of vertical slider
00047   SLIDER_TICKS_RIGHT  = SLIDER_TICKS_BOTTOM,      /// Ticks on the right of vertical slider
00048   SLIDER_NORMAL       = SLIDER_HORIZONTAL
00049   };
00050 
00051 
00052 
00053 /**
00054 * The slider widget is a valuator widget which provides simple linear value range.
00055 * Two visual appearances are supported:- the sunken look, which is enabled with
00056 * the SLIDER_INSIDE_BAR option and the regular look.  The latter may have optional
00057 * arrows on the slider thumb.
00058 * While being moved, the slider sends a SEL_CHANGED message to its target;
00059 * at the end of the interaction, a SEL_COMMAND message is sent.
00060 * The message data represents the current slider value, of type FXint.
00061 */
00062 class FXAPI FXSlider : public FXFrame {
00063   FXDECLARE(FXSlider)
00064 protected:
00065   FXint         range[2];                 // Reported data range
00066   FXint         pos;                      // Reported data position
00067   FXint         incr;                     // Increment when auto-sliding
00068   FXint         delta;                    // Interval between ticks
00069   FXint         headpos;                  // Head position
00070   FXint         headsize;                 // Head size
00071   FXint         slotsize;                 // Slot size
00072   FXColor       slotColor;                // Color of slot the head moves in
00073   FXTimer      *timer;                    // Timer for auto-sliding
00074   FXint         dragpoint;                // Where the head is grabbed
00075   FXString      help;                     // Help string
00076   FXString      tip;                      // Tip string
00077 protected:
00078   FXSlider();
00079   virtual void layout();
00080   FXint headPos(FXint v) const;
00081   FXint headVal(FXint p) const;
00082   void drawSliderHead(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
00083   void drawHorzTicks(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
00084   void drawVertTicks(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
00085 private:
00086   FXSlider(const FXSlider&);
00087   FXSlider &operator=(const FXSlider&);
00088 public:
00089   long onPaint(FXObject*,FXSelector,void*);
00090   long onLeftBtnPress(FXObject*,FXSelector,void*);
00091   long onLeftBtnRelease(FXObject*,FXSelector,void*);
00092   long onMiddleBtnPress(FXObject*,FXSelector,void*);
00093   long onMiddleBtnRelease(FXObject*,FXSelector,void*);
00094   long onUngrabbed(FXObject*,FXSelector,void*);
00095   long onMotion(FXObject*,FXSelector,void*);
00096   long onTimeInc(FXObject*,FXSelector,void*);
00097   long onTimeDec(FXObject*,FXSelector,void*);
00098   long onCmdSetValue(FXObject*,FXSelector,void*);
00099   long onCmdSetIntValue(FXObject*,FXSelector,void*);
00100   long onCmdGetIntValue(FXObject*,FXSelector,void*);
00101   long onCmdSetRealValue(FXObject*,FXSelector,void*);
00102   long onCmdGetRealValue(FXObject*,FXSelector,void*);
00103   long onCmdSetIntRange(FXObject*,FXSelector,void*);
00104   long onCmdGetIntRange(FXObject*,FXSelector,void*);
00105   long onCmdSetRealRange(FXObject*,FXSelector,void*);
00106   long onCmdGetRealRange(FXObject*,FXSelector,void*);
00107   long onQueryHelp(FXObject*,FXSelector,void*);
00108   long onQueryTip(FXObject*,FXSelector,void*);
00109 public:
00110   enum{
00111     ID_AUTOINC=FXFrame::ID_LAST,
00112     ID_AUTODEC,
00113     ID_LAST
00114     };
00115 public:
00116 
00117   /// Construct a slider widget
00118   FXSlider(FXComposite* p,FXObject* tgt=NULL,FXSelector sel=0,FXuint opts=SLIDER_NORMAL,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=0,FXint pr=0,FXint pt=0,FXint pb=0);
00119 
00120   /// Return default width
00121   virtual FXint getDefaultWidth();
00122 
00123   /// Return default height
00124   virtual FXint getDefaultHeight();
00125 
00126   /// Enable the slider
00127   virtual void enable();
00128 
00129   /// Disable the slider
00130   virtual void disable();
00131 
00132   /// Change slider value
00133   void setValue(FXint value);
00134 
00135   /// Return slider value
00136   FXint getValue() const { return pos; }
00137 
00138   /// Change the slider's range
00139   void setRange(FXint lo,FXint hi);
00140 
00141   /// Get the slider's current range
00142   void getRange(FXint& lo,FXint& hi) const { lo=range[0]; hi=range[1]; }
00143 
00144   /// Change the slider style
00145   FXuint getSliderStyle() const;
00146 
00147   /// Get the current slider style
00148   void setSliderStyle(FXuint style);
00149 
00150   /// Get the slider's head size
00151   FXint getHeadSize() const { return headsize; }
00152 
00153   /// Change the slider's head size
00154   void setHeadSize(FXint hs);
00155 
00156   /// Get the slider's current slot size
00157   FXint getSlotSize() const { return slotsize; }
00158 
00159   /// Change the slider's slot size
00160   void setSlotSize(FXint bs);
00161 
00162   /// Get the slider's auto-increment/decrement value
00163   FXint getIncrement() const { return incr; }
00164 
00165   /// Change the slider's auto-increment/decrement value
00166   void setIncrement(FXint inc);
00167 
00168   /// Change the delta between ticks
00169   void setTickDelta(FXint dist);
00170 
00171   /// Get delta between ticks
00172   FXint getTickDelta() const { return delta; }
00173 
00174   /// Change the color of the slot the slider head moves in
00175   void setSlotColor(FXColor clr);
00176 
00177   /// Get the current slot color
00178   FXColor getSlotColor() const { return slotColor; }
00179 
00180   /// Set the help text to be displayed on the status line
00181   void setHelpText(const FXString& text);
00182 
00183   /// Get the current help text
00184   FXString getHelpText() const { return help; }
00185 
00186   /// Set the tip text to be displayed in the tooltip
00187   void setTipText(const FXString& text);
00188 
00189   /// Get the current tooltip text value
00190   FXString getTipText() const { return tip; }
00191 
00192   /// Save to stream
00193   virtual void save(FXStream& store) const;
00194 
00195   /// Load from stream
00196   virtual void load(FXStream& store);
00197 
00198   /// Destroy the slider
00199   virtual ~FXSlider();
00200   };
00201 
00202 
00203 #endif