FXGradientBar.h

/********************************************************************************
*                                                                               *
*                      G r a d i e n t B a r   W i d g e t                      *
*                                                                               *
*********************************************************************************
* Copyright (C) 2002,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 FXGRADIENTBAR_H
#define FXGRADIENTBAR_H

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

namespace FX {


enum {
  GRADIENTBAR_HORIZONTAL      = 0,                          
  GRADIENTBAR_VERTICAL        = 0x00008000,                 
  GRADIENTBAR_NO_CONTROLS     = 0,                          
  GRADIENTBAR_CONTROLS_TOP    = 0x00010000,                 
  GRADIENTBAR_CONTROLS_BOTTOM = 0x00020000,                 
  GRADIENTBAR_CONTROLS_LEFT   = GRADIENTBAR_CONTROLS_TOP,   
  GRADIENTBAR_CONTROLS_RIGHT  = GRADIENTBAR_CONTROLS_BOTTOM 
  };


enum {
  GRADIENT_BLEND_LINEAR,                
  GRADIENT_BLEND_POWER,                 
  GRADIENT_BLEND_SINE,                  
  GRADIENT_BLEND_INCREASING,            
  GRADIENT_BLEND_DECREASING             
  };


// Gradient segment
struct FXGradient {
  FXdouble lower;                     
  FXdouble middle;                    
  FXdouble upper;                     
  FXColor  lowerColor;                
  FXColor  upperColor;                
  FXuchar  blend;                     
  };


class FXImage;


class FXAPI FXGradientBar : public FXFrame {
  FXDECLARE(FXGradientBar)
protected:
  FXImage     *bar;                     // Image containing colors
  FXGradient  *seg;                     // Segments
  FXint        nsegs;                   // Number of segments
  FXint        sellower;                // Lower selected segment
  FXint        selupper;                // Upper selected segment
  FXint        dropped;                 // Dropped segment
  FXint        current;                 // Current segment
  FXint        anchor;                  // Anchor segment
  FXint        grip;                    // Grip being dragged, if any
  FXint        where;                   // Where dropped in segment
  FXint        barsize;                 // Bar size
  FXint        controlsize;             // Size of control
  FXColor      selectColor;             // Select color
  FXString     tip;                     // Tooltip value
  FXString     help;                    // Help value
  FXint        offset;                  // Offset
protected:
  FXGradientBar();
  void updatebar();
  FXdouble getValue(FXint x,FXint y) const;
  FXint getSegmentLowerPos(FXint sg) const;
  FXint getSegmentUpperPos(FXint sg) const;
  FXint getSegmentMiddlePos(FXint sg) const;
  void drawUpArrow(FXDCWindow& dc,FXint x,FXint y,FXColor clr);
  void drawDnArrow(FXDCWindow& dc,FXint x,FXint y,FXColor clr);
  void drawRtArrow(FXDCWindow& dc,FXint x,FXint y,FXColor clr);
  void drawLtArrow(FXDCWindow& dc,FXint x,FXint y,FXColor clr);
  void drawBottomArrows(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  void drawTopArrows(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  void drawLeftArrows(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  void drawRightArrows(FXDCWindow& dc,FXint x,FXint y,FXint w,FXint h);
  static FXdouble blendlinear(FXdouble middle,FXdouble pos);
  static FXdouble blendpower(FXdouble middle,FXdouble pos);
  static FXdouble blendsine(FXdouble middle,FXdouble pos);
  static FXdouble blendincreasing(FXdouble middle,FXdouble pos);
  static FXdouble blenddecreasing(FXdouble middle,FXdouble pos);
  static const FXGradient defaultGradient[3];
private:
  FXGradientBar(const FXGradientBar&);
  FXGradientBar &operator=(const FXGradientBar&);
public:
  enum {
    GRIP_NONE,
    GRIP_LOWER,
    GRIP_SEG_LOWER,
    GRIP_MIDDLE,
    GRIP_SEG_UPPER,
    GRIP_UPPER
    };
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onMotion(FXObject*,FXSelector,void*);
  long onLeftBtnPress(FXObject*,FXSelector,void*);
  long onLeftBtnRelease(FXObject*,FXSelector,void*);
  long onRightBtnPress(FXObject*,FXSelector,void*);
  long onRightBtnRelease(FXObject*,FXSelector,void*);
  long onDNDEnter(FXObject*,FXSelector,void*);
  long onDNDLeave(FXObject*,FXSelector,void*);
  long onDNDMotion(FXObject*,FXSelector,void*);
  long onDNDDrop(FXObject*,FXSelector,void*);
  long onCmdBlending(FXObject*,FXSelector,void*);
  long onUpdBlending(FXObject*,FXSelector,void*);
  long onUpdSegColor(FXObject*,FXSelector,void*);
  long onCmdSegColor(FXObject*,FXSelector,void*);
  long onUpdRecenter(FXObject*,FXSelector,void*);
  long onCmdRecenter(FXObject*,FXSelector,void*);
  long onUpdSplit(FXObject*,FXSelector,void*);
  long onCmdSplit(FXObject*,FXSelector,void*);
  long onUpdMerge(FXObject*,FXSelector,void*);
  long onCmdMerge(FXObject*,FXSelector,void*);
  long onUpdUniform(FXObject*,FXSelector,void*);
  long onCmdUniform(FXObject*,FXSelector,void*);
  long onCmdReset(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_LOWER_COLOR=FXFrame::ID_LAST,
    ID_UPPER_COLOR,
    ID_BLEND_LINEAR,
    ID_BLEND_POWER,
    ID_BLEND_SINE,
    ID_BLEND_INCREASING,
    ID_BLEND_DECREASING,
    ID_RECENTER,
    ID_SPLIT,
    ID_MERGE,
    ID_UNIFORM,
    ID_RESET,
    ID_LAST
    };
public:

  FXGradientBar(FXComposite* p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=FRAME_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);

  virtual void create();

  virtual void layout();

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  FXint getSegment(FXint x,FXint y) const;

  FXint getGrip(FXint sg,FXint x,FXint y) const;

  FXint getNumSegments() const { return nsegs; }

  void resetGradients();

  void setGradients(const FXGradient *segments,FXint nsegments);

  void getGradients(FXGradient*& segments,FXint& nsegments) const;

  void setCurrentSegment(FXint index,FXbool notify=false);

  FXint getCurrentSegment() const { return current; }

  void setAnchorSegment(FXint index);

  FXint getAnchorSegment() const { return anchor; }

  FXbool selectSegments(FXint fm,FXint to,FXbool notify=false);

  FXbool deselectSegments(FXbool notify=false);

  FXbool isSegmentSelected(FXint s) const;

  void setSegmentLowerColor(FXint s,FXColor clr,FXbool notify=false);

  void setSegmentUpperColor(FXint s,FXColor clr,FXbool notify=false);

  FXColor getSegmentLowerColor(FXint s) const;

  FXColor getSegmentUpperColor(FXint s) const;

  void moveSegmentLower(FXint sg,FXdouble val,FXbool notify=false);

  void moveSegmentMiddle(FXint sg,FXdouble val,FXbool notify=false);

  void moveSegmentUpper(FXint sg,FXdouble val,FXbool notify=false);

  void moveSegments(FXint sglo,FXint sghi,FXdouble val,FXbool notify=false);

  FXdouble getSegmentLower(FXint sg) const;

  FXdouble getSegmentMiddle(FXint sg) const;

  FXdouble getSegmentUpper(FXint sg) const;

  void gradient(FXColor *ramp,FXint nramp) const;

  FXuint getSegmentBlend(FXint s) const;

  void splitSegments(FXint sglo,FXint sghi,FXbool notify=false);

  void mergeSegments(FXint sglo,FXint sghi,FXbool notify=false);

  void uniformSegments(FXint sglo,FXint sghi,FXbool notify=false);

  void blendSegments(FXint sglo,FXint sghi,FXuint blend=GRADIENT_BLEND_LINEAR,FXbool notify=false);

  void setControlSize(FXint cs);

  FXint getControlSize() const { return controlsize; }

  void setBarSize(FXint bs);

  FXint getBarSize() const { return barsize; }

  FXuint getBarStyle() const;

  void setBarStyle(FXuint style);

  void setSelectColor(FXColor clr);

  FXColor getSelectColor() const { return selectColor; }

  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 ~FXGradientBar();
  };


}

#endif