wxMaxima
Loading...
Searching...
No Matches
WorksheetLayout.h
Go to the documentation of this file.
1// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
2//
3// Copyright (C) 2026 Gunter Königsmann <wxMaxima@physikbuch.de>
4//
5// This program is free software; you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation; either version 2 of the License, or
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15//
16// You should have received a copy of the GNU General Public License
17// along with this program; if not, write to the Free Software
18// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19//
20// SPDX-License-Identifier: GPL-2.0+
21
36#ifndef WORKSHEETLAYOUT_H
37#define WORKSHEETLAYOUT_H
38
39#include "WorksheetSizeMath.h"
40#include "cells/CellPtr.h"
41#include <functional>
42
43class Cell;
44class GroupCell;
45class Configuration;
46
55public:
66 std::function<GroupCell *()> getTree,
67 std::function<GroupCell *()> getLastCell);
68 // Holds a reference to its view and is bound to one worksheet's tree
69 // callbacks; copying would alias that ownership.
70 WorksheetLayout(const WorksheetLayout &) = delete;
71 WorksheetLayout &operator=(const WorksheetLayout &) = delete;
72
82 void RequestRecalculation(Cell *start);
83
93 bool RecalculateIfNeeded(bool timeout = false, long timeSliceMs = 50);
94
101 void AdjustSize();
102
107 void GetMaxPoint(int *width, int *height);
108
111
118 int GroupCellWidthWithMargins(int cellWidth) const;
119
123 int GetScrollUnit() const { return m_scrollUnit; }
124
132 void RequestAdjustSize() { m_adjustWorksheetSizeNeeded = true; }
133
135 void CancelPendingRecalculation() { m_recalculateStart = nullptr; }
136
137private:
139 Configuration *m_configuration;
141 WorksheetView &m_view;
143 std::function<GroupCell *()> m_getTree;
145 std::function<GroupCell *()> m_getLastCell;
147 CellPtr<GroupCell> m_recalculateStart;
149 int m_maxWidth_Cached = -1;
151 WorksheetVirtualSizeCache m_virtualSizeCache;
157 int m_scrollUnit = 10;
159 bool m_adjustWorksheetSizeNeeded = false;
160};
161
162#endif // WORKSHEETLAYOUT_H
Implementation of an observing weak Cell pointer.
The pure arithmetic that turns a laid-out worksheet's extent into the scrollable (virtual) size and s...
A weak non-owning pointer that becomes null whenever the observed object is destroyed.
Definition: CellPtr.h:511
The base class all cell types the worksheet can consist of are derived from.
Definition: Cell.h:141
The configuration storage for the current worksheet.
Definition: Configuration.h:97
A cell grouping input (and, if there is one, also the output) cell to a foldable item.
Definition: GroupCell.h:87
The layout/recalculation engine of a worksheet.
Definition: WorksheetLayout.h:54
void RequestAdjustSize()
Flag the virtual (scroll) size as needing re-adjustment.
Definition: WorksheetLayout.h:132
void RequestRecalculation(Cell *start)
Schedule a recalculation of the worksheet starting with the cell start.
Definition: WorksheetLayout.cpp:136
void GetMaxPoint(int *width, int *height)
Get the coordinates of the bottom right point of the worksheet.
Definition: WorksheetLayout.cpp:178
void UpdateConfigurationClientSize()
Inform the configuration about the view's current client size.
Definition: WorksheetLayout.cpp:165
void AdjustSize()
Adjust the virtual size and scrollbars to the document's extent.
Definition: WorksheetLayout.cpp:224
int GetScrollUnit() const
The scroll granularity (device px per scroll unit) AdjustSize() last applied.
Definition: WorksheetLayout.h:123
int GroupCellWidthWithMargins(int cellWidth) const
The horizontal space a group cell of the given width occupies.
Definition: WorksheetLayout.cpp:171
bool RecalculateIfNeeded(bool timeout=false, long timeSliceMs=50)
Perform the scheduled recalculation, if one is pending.
Definition: WorksheetLayout.cpp:41
void CancelPendingRecalculation()
Drop any pending recalculation (e.g. when the document is cleared).
Definition: WorksheetLayout.h:135
The narrow view surface the worksheet's layout pipeline needs.
Definition: WorksheetSizeMath.h:172
Remembers the last virtual size applied, so an unchanged size is a no-op.
Definition: WorksheetSizeMath.h:188