viewinterface.hh

Go to the documentation of this file.

/*
 * Scroom - Generic viewer for 2D data
 * Copyright (C) 2009-2026 Kees-Jan Dijkzeul
 *
 * SPDX-License-Identifier: LGPL-2.1
 */
 
#pragma once
 
#include <cmath>
#include <cstdlib>
#include <memory>
#include <string>
 
#include <gtk/gtk.h>
 
#include <scroom/gtk-helpers.hh>
#include <scroom/interface.hh>
#include <scroom/progressinterface.hh>
#include <scroom/rectangle.hh>
 
class PresentationInterface;
class ViewInterface;
 
namespace SelectionType
{
  const std::string GRID("GridSelection");
  const std::string PIXEL("PixelSelection");
  const std::string DEFAULT(GRID);
} // namespace SelectionType
 
struct Selection
{
public:
  using Point = Scroom::Utils::Point<double>;
 
public:
  Point start;
  Point end;
 
public:
  Selection(double x, double y)
    : Selection(Scroom::Utils::make_point(x, y))
  {
  }
 
  explicit Selection(Point point)
    : Selection(point, point)
  {
  }
 
  Selection(Point start_, Point end_)
    : start(start_)
    , end(end_)
  {
  }
 
  Selection& operator=(const Point& p)
  {
    start = p;
    end = p;
    return *this;
  }
 
  [[nodiscard]] double width() const { return abs(end.x - start.x); }
  [[nodiscard]] double height() const { return abs(end.y - start.y); }
  [[nodiscard]] double length() const { return std::hypot(width(), height()); }
};
 
class PostRenderer : private Interface
{
public:
  using Ptr = std::shared_ptr<PostRenderer>;
 
public:
  virtual void render(
    std::shared_ptr<ViewInterface> const& vi,
    cairo_t* cr,
    Scroom::Utils::Rectangle<double> presentationArea,
    int zoom
  ) = 0;
};
 
class SelectionListener : private Interface
{
public:
  using Ptr = std::shared_ptr<SelectionListener>;
 
public:
  virtual std::string getSelectionType() { return SelectionType::DEFAULT; }
 
  virtual void onSelectionStart(Selection selection, std::shared_ptr<ViewInterface> view) = 0;
 
  virtual void onSelectionUpdate(Selection selection, std::shared_ptr<ViewInterface> view) = 0;
 
  virtual void onSelectionEnd(Selection selection, std::shared_ptr<ViewInterface> view) = 0;
};
 
class ToolStateListener : private Interface
{
public:
  using Ptr = std::shared_ptr<ToolStateListener>;
 
public:
  virtual void onEnable() = 0;
 
  virtual void onDisable() = 0;
};
 
class ViewInterface : private Interface
{
public:
  using Ptr = std::shared_ptr<ViewInterface>;
  using WeakPtr = std::weak_ptr<ViewInterface>;
 
public:
  virtual void invalidate() = 0;
 
  virtual ProgressInterface::Ptr getProgressInterface() = 0;
 
  virtual void addSideWidget(std::string title, GtkWidget* w) = 0;
 
  virtual void removeSideWidget(GtkWidget* w) = 0;
 
  virtual void addToToolbar(GtkToolItem* ti) = 0;
 
  virtual void removeFromToolbar(GtkToolItem* ti) = 0;
 
  virtual void registerSelectionListener(SelectionListener::Ptr) = 0;
 
  virtual void registerPostRenderer(PostRenderer::Ptr) = 0;
 
  virtual void setStatusMessage(const std::string&) = 0;
 
  virtual std::shared_ptr<PresentationInterface> getCurrentPresentation() = 0;
 
  virtual void addToolButton(GtkToggleButton*, ToolStateListener::Ptr) = 0;
};