Fl_Scroll.H

//
// Fl_Scroll header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2022 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//
 
/* \file
   Fl_Scroll widget . */
 
#ifndef Fl_Scroll_H
#define Fl_Scroll_H
 
#include "Fl_Group.H"
#include "Fl_Scrollbar.H"

class FL_EXPORT Fl_Scroll : public Fl_Group {
 
  int xposition_, yposition_;
  int oldx, oldy;
  int scrollbar_size_;
  static void hscrollbar_cb(Fl_Widget*, void*);
  static void scrollbar_cb(Fl_Widget*, void*);
  static void draw_clip(void*,int,int,int,int);
 
protected:      //  (STR#1895)

  typedef struct { int x,y,w,h; } Fl_Region_XYWH;

  typedef struct {
    int l;              
    int r;              
    int t;              
    int b;              
  } Fl_Region_LRTB;

  typedef struct {
    int x,y,w,h;
    int pos;            
    int size;           
    int first;          
    int total;          
  } Fl_Scrollbar_Data;

  typedef struct {
    int scrollsize;             
    Fl_Region_XYWH innerbox;    
    Fl_Region_XYWH innerchild;  
    Fl_Region_LRTB child;       
    int hneeded;                
    int vneeded;                
    Fl_Scrollbar_Data hscroll;  
    Fl_Scrollbar_Data vscroll;  
  } ScrollInfo;
  void recalc_scrollbars(ScrollInfo &si) const;
 
protected:
 
  int on_insert(Fl_Widget*, int) FL_OVERRIDE;
  int on_move(int, int) FL_OVERRIDE;
  void fix_scrollbar_order();
  void bbox(int&,int&,int&,int&) const;
  void draw() FL_OVERRIDE;
 
public:
 
  Fl_Scrollbar scrollbar;
  Fl_Scrollbar hscrollbar;
 
  void resize(int X, int Y, int W, int H) FL_OVERRIDE;
  int handle(int) FL_OVERRIDE;
 
  Fl_Scroll(int X, int Y, int W, int H, const char *L = 0);
  virtual ~Fl_Scroll();
 
  enum { // values for type()
    HORIZONTAL = 1,
    VERTICAL = 2,
    BOTH = 3,
    ALWAYS_ON = 4,
    HORIZONTAL_ALWAYS = 5,
    VERTICAL_ALWAYS = 6,
    BOTH_ALWAYS = 7
  };

  int xposition() const {return xposition_;}
  int yposition() const {return yposition_;}
  void scroll_to(int, int);
  void clear();
 
  /* delete child n (by index) */
  int delete_child(int n) FL_OVERRIDE;

  int scrollbar_size() const {
      return(scrollbar_size_);
  }

  void scrollbar_size(int newSize) {
      if ( newSize != scrollbar_size_ ) redraw();
      scrollbar_size_ = newSize;
  }
};
 
#endif