FXScrollArea.h

/********************************************************************************
*                                                                               *
*                       S c r o l l A r e a   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 FXSCROLLAREA_H
#define FXSCROLLAREA_H

#ifndef FXCOMPOSITE_H
#include "FXComposite.h"
#endif

namespace FX {


enum {
  SCROLLERS_NORMAL     = 0,                                 
  HSCROLLER_ALWAYS     = 0x00008000,                        
  HSCROLLER_NEVER      = 0x00010000,                        
  VSCROLLER_ALWAYS     = 0x00020000,                        
  VSCROLLER_NEVER      = 0x00040000,                        
  HSCROLLING_ON        = 0,                                 
  HSCROLLING_OFF       = HSCROLLER_NEVER|HSCROLLER_ALWAYS,  
  VSCROLLING_ON        = 0,                                 
  VSCROLLING_OFF       = VSCROLLER_NEVER|VSCROLLER_ALWAYS,  
  SCROLLERS_TRACK      = 0,                                 
  SCROLLERS_DONT_TRACK = 0x00080000                         
  };


class FXScrollBar;
class FXScrollCorner;


class FXAPI FXScrollArea : public FXComposite {
  FXDECLARE(FXScrollArea)
protected:
  FXScrollBar    *horizontal;   // Horizontal scroll bar
  FXScrollBar    *vertical;     // Vertical scroll bar
  FXScrollCorner *corner;       // Scroll corner
  FXint           pos_x;        // X scroll position (pos_x<=0)
  FXint           pos_y;        // Y scroll position (pos_y<=0)
protected:
  FXScrollArea();
  FXScrollArea(FXComposite* p,FXuint opts,FXint x,FXint y,FXint w,FXint h);
  virtual void moveContents(FXint x,FXint y);
  FXbool startAutoScroll(FXEvent *event,FXbool onlywheninside=false);
  void stopAutoScroll();
  void placeScrollBars(FXint vw,FXint vh);
private:
  FXScrollArea(const FXScrollArea&);
  FXScrollArea &operator=(const FXScrollArea&);
public:
  long onMouseWheel(FXObject*,FXSelector,void*);
  long onHScrollerChanged(FXObject*,FXSelector,void*);
  long onVScrollerChanged(FXObject*,FXSelector,void*);
  long onHScrollerDragged(FXObject*,FXSelector,void*);
  long onVScrollerDragged(FXObject*,FXSelector,void*);
  long onAutoScroll(FXObject*,FXSelector,void*);
public:
  enum {
    ID_AUTOSCROLL=FXComposite::ID_LAST,
    ID_VSCROLLED,
    ID_HSCROLLED,
    ID_LAST
    };
public:

  void setPosition(FXint x,FXint y);

  void getPosition(FXint& x,FXint& y) const { x=pos_x; y=pos_y; }

  FXint getContentX() const { return pos_x; }

  FXint getContentY() const { return pos_y; }

  virtual FXint getContentWidth();

  virtual FXint getContentHeight();

  virtual FXint getVisibleX() const;

  virtual FXint getVisibleY() const;

  virtual FXint getVisibleWidth() const;

  virtual FXint getVisibleHeight() const;

  virtual FXint getDefaultWidth();

  virtual FXint getDefaultHeight();

  virtual void layout();

  FXbool isHorizontalScrollable() const;

  FXbool isVerticalScrollable() const;

  void setScrollStyle(FXuint style);

  FXuint getScrollStyle() const;

  FXScrollBar* horizontalScrollBar() const { return horizontal; }

  FXScrollBar* verticalScrollBar() const { return vertical; }

  virtual void save(FXStream& store) const;

  virtual void load(FXStream& store);

  virtual ~FXScrollArea();
  };

}

#endif