WorksheetLayout.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program 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 General Public License for more details.
//
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef WORKSHEETLAYOUT_H
#define WORKSHEETLAYOUT_H
 
#include "WorksheetSizeMath.h"
#include "cells/CellPtr.h"
#include <functional>
 
class Cell;
class GroupCell;
class Configuration;
 
class WorksheetLayout {
public:
  WorksheetLayout(Configuration *config, WorksheetView &view,
                  std::function<GroupCell *()> getTree,
                  std::function<GroupCell *()> getLastCell);
  // Holds a reference to its view and is bound to one worksheet's tree
  // callbacks; copying would alias that ownership.
  WorksheetLayout(const WorksheetLayout &) = delete;
  WorksheetLayout &operator=(const WorksheetLayout &) = delete;
 
  void RequestRecalculation(Cell *start);
 
  void RequestFullRecalculation();
 
  bool RecalculateIfNeeded(bool timeout = false, long timeSliceMs = 50);
 
  void AdjustSize();
 
  void GetMaxPoint(int *width, int *height);
 
  void UpdateConfigurationClientSize();
 
  int GroupCellWidthWithMargins(int cellWidth) const;
 
  int GetScrollUnit() const { return m_scrollUnit; }
 
  void RequestAdjustSize() { m_adjustWorksheetSizeNeeded = true; }
 
  void CancelPendingRecalculation() {
    m_recalculateStart = nullptr;
    m_recalculateEnd = nullptr;
  }
 
  struct ScrollAnchor {
    GroupCell *cell = nullptr;
    bool atBottom = false;
    bool operator==(const ScrollAnchor &) const = default;
  };
 
  void SetScrollAnchorCallback(std::function<ScrollAnchor()> callback)
    { m_getScrollAnchor = std::move(callback); }
 
  void ArmScrollCompensation();
 
  void ArmScrollCompensation(GroupCell *cell);
 
  static GroupCell *FirstGroupReachingBelow(GroupCell *tree, int y);
 
  static int AnchorY(const ScrollAnchor &anchor);
 
  bool ScrollCompensationArmed() const { return m_scrollAnchor != nullptr; }
 
  int GetLastCellsVisited() const { return m_lastCellsVisited; }
  int GetLastCellsRecalculated() const { return m_lastCellsRecalculated; }
 
private:
  void ApplyScrollCompensation();
 
  Configuration *m_configuration;
  WorksheetView &m_view;
  std::function<GroupCell *()> m_getTree;
  std::function<GroupCell *()> m_getLastCell;
  CellPtr<GroupCell> m_recalculateStart;
  CellPtr<GroupCell> m_recalculateEnd;
  int m_maxWidth_Cached = -1;
  WorksheetVirtualSizeCache m_virtualSizeCache;
  int m_scrollUnit = 10;
  bool m_adjustWorksheetSizeNeeded = false;
  std::function<ScrollAnchor()> m_getScrollAnchor;
  CellPtr<GroupCell> m_scrollAnchor;
  bool m_scrollAnchorAtBottom = false;
  bool m_scrollAnchorIsCursor = false;
  int m_scrollAnchorY = 0;
  int m_lastCellsVisited = 0;
  int m_lastCellsRecalculated = 0;
};
 
#endif // WORKSHEETLAYOUT_H