FXSlider.h

/********************************************************************************
*                                                                               *
*                           S l i d e r   W i d g e t                           *
*                                                                               *
*********************************************************************************
* Copyright (C) 1997,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                 *
* GNU Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXSLIDER_H
#define FXSLIDER_H

#ifndef FXFRAME_H
#include "FXFrame.h"
#endif

namespace FX {


enum {
  SLIDER_HORIZONTAL   = 0,                        
  SLIDER_VERTICAL     = 0x00008000,               
  SLIDER_ARROW_UP     = 0x00010000,               
  SLIDER_ARROW_DOWN   = 0x00020000,               
  SLIDER_ARROW_LEFT   = SLIDER_ARROW_UP,          
  SLIDER_ARROW_RIGHT  = SLIDER_ARROW_DOWN,        
  SLIDER_INSIDE_BAR   = 0x00040000,               
  SLIDER_TICKS_TOP    = 0x00080000,               
  SLIDER_TICKS_BOTTOM = 0x00100000,               
  SLIDER_TICKS_LEFT   = SLIDER_TICKS_TOP,         
  SLIDER_TICKS_RIGHT  = SLIDER_TICKS_BOTTOM,      
  SLIDER_NORMAL       = SLIDER_HORIZONTAL
  };


class FXAPI FXSlider : public FXFrame {
  FXDECLARE(FXSlider)
protected:
  FXint         headPos;                  // Head position
  FXint         headSize;                 // Head size
  FXint         slotSize;                 // Slot size
  FXColor       slotColor;                // Color of slot the head moves in
  FXint         dragPoint;                // Where the head is grabbed
  FXint         range[2];                 // Reported data range
  FXint         delta;                    // Interval between ticks
  FXint         incr;                     // Increment when auto-sliding
  FXint         pos;                      // Reported data position
  FXString      help;                     // Help string
  FXString      tip;                      // Tip string
protected:
  FXSlider();
  void drawSliderHead(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  void drawHorzTicks(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  void drawVertTicks(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
private:
  FXSlider(const FXSlider&);
  FXSlider &operator=(const FXSlider&);
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onMotion(FXObject*,FXSelector,void*);
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onLeftBtnPress(FXObject*,FXSelector,void*);
  long onLeftBtnRelease(FXObject*,FXSelector,void*);
  long onMiddleBtnPress(FXObject*,FXSelector,void*);
  long onMiddleBtnRelease(FXObject*,FXSelector,void*);
  long onKeyPress(FXObject*,FXSelector,void*);
  long onKeyRelease(FXObject*,FXSelector,void*);
  long onUngrabbed(FXObject*,FXSelector,void*);
  long onAutoSlide(FXObject*,FXSelector,void*);
  long onCmdSetValue(FXObject*,FXSelector,void*);
  long onCmdSetIntValue(FXObject*,FXSelector,void*);
  long onCmdGetIntValue(FXObject*,FXSelector,void*);
  long onCmdSetLongValue(FXObject*,FXSelector,void*);
  long onCmdGetLongValue(FXObject*,FXSelector,void*);
  long onCmdSetRealValue(FXObject*,FXSelector,void*);
  long onCmdGetRealValue(FXObject*,FXSelector,void*);
  long onCmdSetIntRange(FXObject*,FXSelector,void*);
  long onCmdGetIntRange(FXObject*,FXSelector,void*);
  long onCmdSetRealRange(FXObject*,FXSelector,void*);
  long onCmdGetRealRange(FXObject*,FXSelector,void*);
  long onCmdSetHelp(FXObject*,FXSelector,void*);
  long onCmdGetHelp(FXObject*,FXSelector,void*);
  long onCmdSetTip(FXObject*,FXSelector,void*);
  long onCmdGetTip(FXObject*,FXSelector,void*);
  long onQueryHelp(FXObject*,FXSelector,void*);
  long onQueryTip(FXObject*,FXSelector,void*);
public:
  enum{
    ID_AUTOSLIDE=FXFrame::ID_LAST,
    ID_LAST
    };
public:

  FXSlider(FXComposite* p,FXObject* tgt=nullptr,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);

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  virtual FXbool canFocus() const;

  virtual void layout();

  virtual void enable();

  virtual void disable();

  void setValue(FXint value,FXbool notify=false);

  FXint getValue() const { return pos; }

  void setRange(FXint lo,FXint hi,FXbool notify=false);

  void getRange(FXint& lo,FXint& hi) const { lo=range[0]; hi=range[1]; }

  FXuint getSliderStyle() const;

  void setSliderStyle(FXuint style);

  FXint getHeadSize() const { return headSize; }

  void setHeadSize(FXint hs);

  FXint getSlotSize() const { return slotSize; }

  void setSlotSize(FXint bs);

  FXint getIncrement() const { return incr; }

  void setIncrement(FXint inc);

  void setTickDelta(FXint dist);

  FXint getTickDelta() const { return delta; }

  void setSlotColor(FXColor clr);

  FXColor getSlotColor() const { return slotColor; }

  void setHelpText(const FXString& text){ help=text; }

  const FXString& getHelpText() const { return help; }

  void setTipText(const FXString& text){ tip=text; }

  const FXString& getTipText() const { return tip; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXSlider();
  };

}

#endif