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

FXSlider.h

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

Copyright © 1997-2009 Jeroen van der Zijp