FXRulerView.h

/********************************************************************************
*                                                                               *
*                         R u l e r V i e w   W i d g e t                       *
*                                                                               *
*********************************************************************************
* Copyright (C) 2005,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 FXRULERVIEW_H
#define FXRULERVIEW_H

#ifndef FXSCROLLAREA_H
#include "FXScrollArea.h"
#endif

namespace FX {


class FXRuler;
class FXFrame;


class FXAPI FXRulerView : public FXScrollArea {
  FXDECLARE(FXRulerView)
protected:
  FXRuler *hruler;      // Horizontal ruler
  FXRuler *vruler;      // Vertical ruler
  FXFrame *filler;      // Corner thingy
  FXColor  docColor;    // Color of document
  FXString tip;         // Tooltip text
  FXString help;        // Help text
protected:
  FXRulerView();
  virtual void moveContents(FXint x,FXint y);
  virtual void drawBackground(FXDCWindow& dc);
  virtual void drawContents(FXDCWindow& dc);
private:
  FXRulerView(const FXRulerView&);
  FXRulerView &operator=(const FXRulerView&);
public:
  long onPaint(FXObject*,FXSelector,void*);
  long onMotion(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*);
  long onDocChanged(FXObject*,FXSelector,void*);
public:
  enum {
    ID_HRULER=FXScrollArea::ID_LAST,
    ID_VRULER,
    ID_LAST
    };
public:

  FXRulerView(FXComposite* p,FXObject* tgt=nullptr,FXSelector sel=0,FXuint opts=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0);

  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();

  FXRuler* horizontalRuler() const { return hruler; }

  FXRuler* verticalRuler() const { return vruler; }

  FXint getDocumentX() const;

  FXint getDocumentY() const;

  void setDocumentWidth(FXint w,FXbool notify=false);

  FXint getDocumentWidth() const;

  void setDocumentHeight(FXint h,FXbool notify=false);

  FXint getDocumentHeight() const;

  void setDocumentColor(FXColor clr);

  FXColor getDocumentColor() const { return docColor; }

  void setHEdgeSpacing(FXint es,FXbool notify=false);
  void setVEdgeSpacing(FXint es,FXbool notify=false);

  FXint getHEdgeSpacing() const;
  FXint getVEdgeSpacing() const;

  void setHMarginLower(FXint marg,FXbool notify=false);

  void setHMarginUpper(FXint marg,FXbool notify=false);

  FXint getHMarginLower() const;

  FXint getHMarginUpper() const;

  void setVMarginLower(FXint marg,FXbool notify=false);

  void setVMarginUpper(FXint marg,FXbool notify=false);

  FXint getVMarginLower() const;

  FXint getVMarginUpper() const;

  void setHAlignment(FXuint align,FXbool notify=false);

  FXuint getHAlignment() const;

  void setVAlignment(FXuint align,FXbool notify=false);

  FXuint getVAlignment() const;

  void setArrowPosX(FXint x);

  void setArrowPosY(FXint y);

  FXint getArrowPosX() const;

  FXint getArrowPosY() const;

  void setHRulerFont(FXFont *fnt,FXbool notify=false);

  FXFont* getHRulerFont() const;

  void setVRulerFont(FXFont *fnt,FXbool notify=false);

  FXFont* getVRulerFont() const;

  void setHNumberTicks(FXint ticks,FXbool notify=false);
  void setVNumberTicks(FXint ticks,FXbool notify=false);

  FXint getHNumberTicks() const;
  FXint getVNumberTicks() const;

  void setHMajorTicks(FXint ticks,FXbool notify=false);
  void setVMajorTicks(FXint ticks,FXbool notify=false);

  FXint getHMajorTicks() const;
  FXint getVMajorTicks() const;

  void setHMediumTicks(FXint ticks,FXbool notify=false);
  void setVMediumTicks(FXint ticks,FXbool notify=false);

  FXint getHMediumTicks() const;
  FXint getVMediumTicks() const;

  void setHTinyTicks(FXint ticks,FXbool notify=false);
  void setVTinyTicks(FXint ticks,FXbool notify=false);

  FXint getHTinyTicks() const;
  FXint getVTinyTicks() const;

  void setHPixelPerTick(FXdouble space,FXbool notify=false);
  void setVPixelPerTick(FXdouble space,FXbool notify=false);

  FXdouble getHPixelPerTick() const;
  FXdouble getVPixelPerTick() const;

  void setHRulerStyle(FXuint style);
  void setVRulerStyle(FXuint style);

  FXuint getHRulerStyle() const;
  FXuint getVRulerStyle() const;

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

}

#endif