wxMaxima
Loading...
Searching...
No Matches
Cell.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) 2004-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
4// Copyright (C) 2014-2018 Gunter Königsmann <wxMaxima@physikbuch.de>
5// Copyright (C) 2020 Kuba Ober <kuba@bertec.com>
6//
7// This program is free software; you can redistribute it and/or modify
8// it under the terms of the GNU General Public License as published by
9// the Free Software Foundation; either version 2 of the License, or
10// (at your option) any later version.
11//
12// This program is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15// GNU General Public License for more details.
16//
17//
18// You should have received a copy of the GNU General Public License
19// along with this program; if not, write to the Free Software
20// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21//
22// SPDX-License-Identifier: GPL-2.0+
23
29#ifndef CELL_H
30#define CELL_H
31
32#include "../precomp.h"
33#include "CellPtr.h"
34#include "CellIterators.h"
35#include "Configuration.h"
36#include "StringUtils.h"
37#include "TextStyle.h"
38#include "CachedValue.h"
39#include <wx/defs.h>
40#if wxUSE_ACCESSIBILITY
41#include <wx/access.h>
42#endif // wxUSE_ACCESSIBILITY
43#include <algorithm>
44#include <map>
45#include <memory>
46#include <vector>
47#include <type_traits>
48class CellPointers;
49class EditorCell;
50class GroupCell;
51class TextCell;
52class Worksheet;
53class wxXmlNode;
54
55// Forward declarations
56template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
57inline auto OnInner(const C *cell);
58template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
59inline auto OnInner(C *cell);
60
63enum CellType : int8_t
64{
65 MC_TYPE_DEFAULT,
83};
85std::ostream& operator<<(std::ostream& out, const CellType celltype);
86
87#if wxUSE_ACCESSIBILITY
88class CellAccessible;
89#endif
90
93{
94public:
100 virtual const wxString &GetName() const = 0;
101};
102
140// 120 bytes
141class Cell: public Observed
142{
143#if wxUSE_ACCESSIBILITY
144 friend class CellAccessible;
145#endif
146 friend class CellList;
147
148 // This class can be derived from wxAccessible which has no copy constructor
149 void operator=(const Cell&) = delete;
151 Cell(GroupCell *group, const Cell&) = delete;
152
153 template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type>
154 friend inline auto OnInner(const C *cell);
155 template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type>
156 friend inline auto OnInner(C *cell);
157
158public:
159// Cell(GroupCell *group, Configuration *config);
160 Cell(GroupCell *group, Configuration *config);
161
167 virtual std::unique_ptr<Cell> Copy(GroupCell *group) const = 0;
168
170 virtual const CellTypeInfo &GetInfo() = 0;
171
176 wxCoord Scale_Px(double px) const {return m_configuration->Scale_Px(px);}
181 AFontSize Scale_Px(AFontSize size) const { return m_configuration->Scale_Px(size); }
182
183#if wxUSE_ACCESSIBILITY
184 // The methods whose implementation within Cell should be sufficient are
185 // not virtual. Should that prove not to be the case eventually, they can be
186 // made virtual with due caution.
188 wxAccStatus GetParent (Cell ** parent) const;
190 wxAccStatus GetChild(int childId, Cell **child) const;
192 wxAccStatus HitTest (const wxPoint &pt, int *childId, Cell **child);
193
195 virtual wxAccStatus GetDescription(int childId, wxString *description) const;
197 virtual wxAccStatus GetFocus (int *childId, Cell **child) const;
199 virtual wxAccStatus GetDefaultAction(int childId, wxString *actionName) const;
201 virtual wxAccStatus GetLocation (wxRect &rect, int elementId);
203 virtual wxAccStatus GetValue (int childId, wxString *strValue) const;
204 virtual wxAccStatus GetRole (int childId, wxAccRole *role) const;
205#endif
206
207
215 virtual const wxString GetToolTip(wxPoint point) const;
216
218 virtual ~Cell();
219
221 unsigned long CellsInListRecursive() const;
222
224 wxRect CropToUpdateRegion(wxRect rect) const;
225
227 bool InUpdateRegion() const;
228
230 void SoftLineBreak(bool breakLine = true) { m_breakLine = breakLine; }
231
236 bool BreakUpCells();
237
239 bool UnBreakUpCells();
240
241 /* Break lines in this list of cells
242 */
243 void BreakLines_List();
244
246 int GetLineIndent() const;
247
249 bool BreakLineHere() const { return m_breakLine || m_forceBreakLine; }
250
252 bool HasHardLineBreak() const { return m_forceBreakLine; }
253
258 virtual bool BreakUp();
259
260protected:
266 void BreakUpAndMark();
267
268protected:
270 wxBitmap BitmapFromSVG(wxString svgData, wxSize size);
271public:
279 bool ContainsRect(const wxRect &sm, bool all = true) const;
280
285 bool ContainsPoint(wxPoint point) const { return GetRect().Contains(point); }
286
292 virtual void ClearCache()
293 {}
294
299 void ClearCacheList();
303 virtual void SetConfiguration(Configuration *config);
306
307
317 virtual void Draw(wxPoint point, wxDC *dc, wxDC *antialiassingDC);
318
323 void DrawList(wxPoint point, wxDC *dc, wxDC *adc);
324 void DrawList(wxDC *dc, wxDC *adc){DrawList(m_currentPoint, dc, adc);}
325
333 virtual void DrawBoundingBox(wxDC &WXUNUSED(dc), bool all = false);
334
339 bool DrawThisCell(wxPoint point);
343
350 void ForceBreakLine(bool force = true) { m_forceBreakLine = m_breakLine = force; }
351
360 wxCoord GetHeight() const
361 { return m_height; }
362
371 int GetWidth() const
372 { return m_width; }
373
383 wxCoord GetCenter() const
384 { return m_center; }
385
387 bool HasValidSize() const;
389 bool HasStaleSize() const;
391 bool HasValidPosition() const;
392
406 wxCoord GetDrop() const
407 { return m_height - m_center; }
408
413 { return m_type; }
414
421 wxCoord GetMaxDrop() const;
422
429 wxCoord GetCenterList() const;
430
435 wxCoord GetHeightList() const;
436
438 wxCoord GetFullWidth() const;
439
445 wxCoord GetLineWidth() const;
446
451 wxCoord GetCurrentX() const
452 { return m_currentPoint.x; }
453
458 wxCoord GetCurrentY() const
459 { return m_currentPoint.y; }
460
467 virtual wxRect GetRect(bool wholeList = false) const;
468
470 virtual bool NeedsRecalculation(AFontSize fontSize) const;
471
473 void ScheduleRecalculation(){m_cellCfgCnt_last = m_configuration->CellCfgCnt() - 1 ;}
475 bool ConfigChanged() const {return m_configuration->CellCfgCnt() != m_cellCfgCnt_last;}
482 virtual wxString GetDiffPart() const;
483
491 virtual void Recalculate(AFontSize fontsize);
492
497 void RecalculateList(AFontSize fontsize);
498
500 void FontsChangedList();
501
504
507
509 void ResetSize();
510
512 void ResetSizeList();
513
515 void SetBigSkip(bool skip) { m_bigSkip = skip; }
517 bool HasBigSkip() const { return m_bigSkip; }
518
520 virtual void SetType(CellType type);
521
523 const TextStyle &GetTextStyle() const
524 { return m_textStyle; }
525
527 // cppcheck-suppress functionStatic
528 // cppcheck-suppress functionConst
529 void SetPen(wxDC *dc, double lineWidth = 1.0) const;
531 void SetBrush(wxDC *dc) const;
532 wxColour GetForegroundColor() const;
533
535 void SetHighlight(bool highlight) { m_highlight = highlight; }
537 bool GetHighlight() const { return m_highlight; }
538
543 virtual void SetIsExponent();
544
549 virtual void SetIsExponentList();
550
555 virtual void SetValue(const wxString &WXUNUSED(text)) {}
557 virtual const wxString &GetValue() const;
558 virtual const wxString GetDisplayedString() const {return GetValue();}
559
561 Cell *first() const;
562
564 Cell *last() const;
565
567 struct Range {
568 Cell *first, *last;
569 };
570
574 Range GetCellsInRect(const wxRect &rect) const;
575
579 Range GetListCellsInRect(const wxRect &rect) const;
580
582 virtual Range GetInnerCellsInRect(const wxRect &rect) const;
583
585 virtual bool IsOperator() const { return false; }
586
588 bool IsCompound() const;
589
591 virtual bool IsShortNum() const { return false; }
592
594 GroupCell *GetGroup() const;
595
598 {
599 public:
600 double x, y;
601 };
602
604 virtual wxString ListToString() const;
605
610 wxString VariablesAndFunctionsList() const;
612 virtual wxString ListToMatlab() const;
614 virtual wxString ListToTeX() const;
616 virtual wxString ListToXML() const;
617
619 virtual wxString ListToMathML(bool startofline = false) const;
620
622 virtual wxString ListToOMML(bool startofline = false) const;
623
625 virtual wxString ListToRTF(bool startofline = false) const;
626
628 virtual wxString ToString() const;
629
635 virtual wxString ToRTF() const
636 { return wxEmptyString; }
637
639 static wxString OMML2RTF(wxXmlNode *node);
640
642 static wxString OMML2RTF(wxString ommltext);
643
653 virtual wxString ToOMML() const;
655 virtual wxString ToMatlab() const;
657 virtual wxString ToTeX() const;
659 virtual wxString ToXML() const;
661 virtual wxString ToMathML() const;
662
664 static wxString RTFescape(wxString, bool MarkDown = false);
665
667 static wxString XMLescape(wxString);
668
669 // cppcheck-suppress functionStatic
670 // cppcheck-suppress functionConst
671
679 virtual void Unbreak();
680
688 virtual void UnbreakList();
689
691 Cell *GetPrevious() const { return m_previous; }
692
694 Cell *GetNext() const { return m_next.get(); }
701 Cell *GetNextToDraw() const { return m_nextToDraw; }
702
710 virtual void SetNextToDraw(Cell *next) { m_nextToDraw = next; }
711 template <typename T, typename Del,
712 typename std::enable_if<std::is_base_of<Cell, T>::value, bool>::type = true>
720 void SetNextToDraw(const std::unique_ptr<T, Del> &ptr) { SetNextToDraw(ptr.get()); }
721
726 bool IsComment() const
727 {
728 return m_type == MC_TYPE_TEXT || m_type == MC_TYPE_SECTION ||
729 m_type == MC_TYPE_SUBSECTION || m_type == MC_TYPE_SUBSUBSECTION ||
730 m_type == MC_TYPE_HEADING5 || m_type == MC_TYPE_HEADING6 || m_type == MC_TYPE_TITLE;
731 }
732
742 bool IsHidden() const { return m_isHidden; }
743
745 virtual bool FirstLineOnlyEditor();
746
748 virtual void Hide(bool hide = true) { m_isHidden = hide; }
749
754 bool IsEditable(bool input = false) const
755 {
756 return (m_type == MC_TYPE_INPUT &&
757 m_previous && m_previous->m_type == MC_TYPE_MAIN_PROMPT)
758 || (!input && IsComment());
759 }
760
762 virtual bool CanPopOut() const { return false; }
763
768 virtual wxString GnuplotSource() const {return wxEmptyString;}
769
771 virtual void ProcessEvent(wxKeyEvent &WXUNUSED(event))
772 {}
773
778 virtual bool AddEnding()
779 { return false; }
780
782 virtual void SelectPointText(wxPoint point);
783
785 virtual void SelectRectText(wxPoint one, wxPoint two);
786
793 virtual void PasteFromClipboard(bool primary = false);
794
798 virtual bool CopyToClipboard() const
799 { return false; }
800
804 virtual bool CutToClipboard()
805 { return false; }
806
808 virtual void SelectAll()
809 {}
810
812 virtual bool CanCopy() const
813 { return false; }
814
816 virtual wxPoint PositionToPoint(size_t WXUNUSED(pos))
817 { return wxPoint(-1, -1); }
818
820 virtual wxPoint PositionToPoint()
821 { return wxPoint(-1, -1); }
822
824 virtual bool IsDirty() const
825 { return false; }
826
827 virtual void SwitchCaretDisplay()
828 {}
829
831 virtual void SetFocus(bool WXUNUSED(focus))
832 {}
833
835 void SetTextColor(wxDC *dc);
836
838 virtual bool IsActive() const
839 { return false; }
840
842 virtual void SetStyle(TextStyle style)
843 {
845 m_textStyle = style;
846 }
848 bool IsMath() const;
849
851 virtual int GetImageBorderWidth() const { return 0; }
852
854 void CopyCommonData(const Cell & cell);
855
857 std::unique_ptr<Cell> CopyList(GroupCell *group) const;
858
860 static std::unique_ptr<Cell> CopyList(GroupCell *group, const Cell *cell);
861
863 void ClearToolTip();
865 void SetToolTip(const wxString &tooltip);
869 void SetToolTip(const wxString *toolTip);
871 void AddToolTip(const wxString &tip);
873 virtual void SetCurrentPoint(wxPoint point) { m_currentPoint = point; }
875 void SetCurrentPoint(int x, int y) { SetCurrentPoint({x, y}); }
877 wxPoint GetCurrentPoint() const {return m_currentPoint;}
878
885 bool IsBrokenIntoLines() const { return m_isBrokenIntoLines; }
886
895 bool GetSuppressMultiplicationDot() const { return m_suppressMultiplicationDot; }
896 void SetSuppressMultiplicationDot(bool val) { m_suppressMultiplicationDot = val; }
898 bool GetHidableMultSign() const { return m_isHidableMultSign; }
899 void SetHidableMultSign(bool val) { m_isHidableMultSign = val; }
900
911 virtual void SetAltCopyText(const wxString &text);
913 virtual const wxString &GetAltCopyText() const { return wxm::emptyString; }
914
915#if wxUSE_ACCESSIBILITY
916 CellAccessible *GetAccessible();
917#endif
918#if CELL_TEST
919 void MockBreakUp() { m_isBrokenIntoLines = 1; }
920#endif
921
922 static wxString wxColor2HtmlString(wxColor col);
923protected:
924 std::unique_ptr<Cell> MakeVisiblyInvalidCell() const;
925public:
926 static std::unique_ptr<Cell> MakeVisiblyInvalidCell(GroupCell *group, Configuration *config);
927
928protected:
929//** Bases and internal members (16 bytes)
930//**
931// VTable *__vtable;
932// Observed __observed;
933
934//** 8-byte objects (8 bytes)
935//**
949 wxPoint m_currentPoint{-1, -1};
950
951protected:
952//** 8/4-byte objects (40 + 8* bytes)
953//**
954
955private:
957 std::int_fast32_t m_cellCfgCnt_last = -1;
959 std::unique_ptr<Cell> m_next;
960
962 Cell *m_previous = {};
963
964#if wxUSE_ACCESSIBILITY
965 std::unique_ptr<CellAccessible> m_accessible;
966#endif
967
968public:
969 const wxString &GetLocalToolTip() const;
970protected:
976
979
982 const wxString *m_toolTip /* initialized in the constructor */;
983
984//** 4-byte objects (28 bytes)
985//**
986protected:
993 wxCoord m_height = -1;
997 wxCoord m_width = -1;
1004 wxCoord m_center = -1;
1005protected:
1006//** 2-byte objects (2 bytes)
1007//**
1010
1011//** 1-byte objects (2 bytes)
1012//**
1013 // The celltype of this object
1014 CellType m_type = MC_TYPE_DEFAULT;
1015 // The text style of this object
1016 TextStyle m_textStyle = TS_MATH;
1017
1018private:
1019//** Bitfield objects (2 bytes)
1020//**
1021 void InitBitFields_Cell()
1022 { // Keep the initialization order below same as the order
1023 // of bit fields in this class!
1024 m_ownsToolTip = false;
1025 m_bigSkip = false;
1026 m_isBrokenIntoLines = false;
1027 m_isHidden = false;
1028 m_isHidableMultSign = false;
1029 m_suppressMultiplicationDot = false;
1030 m_breakLine = false;
1031 m_forceBreakLine = false;
1032 m_highlight = false;
1033 }
1034
1035 // In the boolean bit fields below, InitBitFields_Cell is an indication that
1036 // the InitBitFields_Cell() method initializes a given field. It should be
1037 // only added once such initialization is in place. It makes it easier
1038 // to verify that all bit fields are initialized.
1039
1041 bool m_ownsToolTip : 1 /* InitBitFields_Cell */;
1042 bool m_bigSkip : 1 /* InitBitFields_Cell */;
1043 bool m_isBrokenIntoLines : 1 /* InitBitFields_Cell */;
1044 bool m_isHidden : 1 /* InitBitFields_Cell */;
1045 bool m_isHidableMultSign : 1 /* InitBitFields_Cell */;
1046 bool m_suppressMultiplicationDot : 1 /* InitBitFields_Cell */;
1048 bool m_breakLine : 1 /* InitBitFields_Cell */;
1049 bool m_forceBreakLine : 1 /* InitBitFields_Cell */;
1050 bool m_highlight : 1 /* InitBitFields_Cell */;
1051
1052protected:
1053 friend class InnerCellIterator;
1055 virtual size_t GetInnerCellCount() const;
1058 virtual Cell *GetInnerCell(size_t index) const;
1059
1060 inline Worksheet *GetWorksheet() const;
1061
1063 virtual void FontsChanged()
1065
1066 CellPointers *GetCellPointers() const;
1067
1068private:
1069 void RecalcCenterListAndMaxDropCache();
1070};
1071
1072// The static cast here requires Cell to be defined
1073template <typename T>
1074template <typename PtrT, typename std::enable_if<std::is_pointer<PtrT>::value, bool>::type>
1075inline PtrT CellPtr<T>::CastAs() const noexcept { return dynamic_cast<PtrT>(static_cast<Cell*>(base_get())); }
1076
1077#if wxUSE_ACCESSIBILITY
1078class CellAccessible final : public wxAccessible
1079{
1080public:
1081 explicit CellAccessible(Cell *const forCell) : m_cell(forCell) {}
1082
1084 wxAccStatus GetParent (wxAccessible **parent) override;
1086 wxAccStatus GetChildCount (int *childCount) override;
1088 wxAccStatus GetChild (int childId, wxAccessible **child) override;
1090 wxAccStatus HitTest (const wxPoint &pt,
1091 int *childId, wxAccessible **child) override;
1093 wxAccStatus GetDescription(int childId, wxString *description) override;
1095 wxAccStatus GetDefaultAction(int childId, wxString *actionName) override;
1097 wxAccStatus GetFocus (int *childId, wxAccessible **child) override;
1099 wxAccStatus GetLocation (wxRect &rect, int elementId) override;
1101 wxAccStatus GetValue (int childId, wxString *strValue) override;
1102 wxAccStatus GetRole (int childId, wxAccRole *role) override;
1103private:
1104 Cell *const m_cell;
1105};
1106#endif
1107
1109template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
1110inline auto OnList(const C *cell) { return CellListAdapter<const C>(cell); }
1111template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
1112inline auto OnList(C *cell) { return CellListAdapter<C>(cell); }
1113
1115template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
1116inline auto OnDrawList(const C *cell) { return CellDrawListAdapter<const C>(cell); }
1117template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type = true>
1118inline auto OnDrawList(C *cell) { return CellDrawListAdapter<C>(cell); }
1119
1121template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type>
1122inline auto OnInner(const C *cell) { return InnerCellAdapter(const_cast<Cell *>(cell)); }
1123template <typename C, typename std::enable_if<std::is_base_of<Cell, C>::value, bool>::type>
1124inline auto OnInner(C *cell) { return InnerCellAdapter(cell); }
1125
1126inline size_t InnerCellIterator::GetInnerCellCount(const Cell *cell) { return cell->GetInnerCellCount(); }
1127inline Cell *InnerCellIterator::GetInnerCell(const Cell *cell, size_t index) { return cell->GetInnerCell(index); }
1128
1129#endif // CELL_H
Declares "mostly read-only" wrappers around values that are expensive to compute and are thus cached.
Declares the various iterators useful with the Cell class.
Implementation of an observing weak Cell pointer.
auto OnList(const C *cell)
Returns an iterable the goes over the cell list, starting with given, possibly null,...
Definition: Cell.h:1110
std::ostream & operator<<(std::ostream &out, const CellType celltype)
Allow Standard c++ streams to print out our enum values as text.
Definition: Cell.cpp:1438
auto OnDrawList(const C *cell)
Returns an iterable that goes over the cell draw list, starting with given, possibly null,...
Definition: Cell.h:1116
CellType
The supported types of math cells.
Definition: Cell.h:64
@ MC_TYPE_WARNING
A warning output by maxima.
Definition: Cell.h:70
@ MC_TYPE_PROMPT
Maxima questions or lisp prompts.
Definition: Cell.h:67
@ MC_TYPE_SECTION
A section name.
Definition: Cell.h:78
@ MC_TYPE_ASCIIMATHS
Equations displayed in 2D.
Definition: Cell.h:73
@ MC_TYPE_LABEL
An output label generated by maxima.
Definition: Cell.h:68
@ MC_TYPE_GROUP
A group cells that bundles several individual cells together.
Definition: Cell.h:82
@ MC_TYPE_MAIN_PROMPT
Input labels.
Definition: Cell.h:66
@ MC_TYPE_SUBSECTION
A subsection name.
Definition: Cell.h:74
@ MC_TYPE_INPUT
A cell containing code.
Definition: Cell.h:69
@ MC_TYPE_HEADING5
A subsubsection name.
Definition: Cell.h:76
@ MC_TYPE_TITLE
The title of the document.
Definition: Cell.h:79
@ MC_TYPE_SLIDE
An animation created by the with_slider_* maxima commands.
Definition: Cell.h:81
@ MC_TYPE_SUBSUBSECTION
A subsubsection name.
Definition: Cell.h:75
@ MC_TYPE_HEADING6
A subsubsection name.
Definition: Cell.h:77
@ MC_TYPE_TEXT
Text that isn't passed to maxima.
Definition: Cell.h:72
@ MC_TYPE_IMAGE
An image.
Definition: Cell.h:80
@ MC_TYPE_ERROR
An error output by maxima.
Definition: Cell.h:71
auto OnInner(const C *cell)
Returns an iterable that goes over the inner cells of this cell.
Definition: Cell.h:1122
This file declares everything needed for the text style system used to style all the elements on the ...
TextStyle
All text styles known to wxMaxima.
Definition: TextStyle.h:231
A Type-Safe Fixed-Point Font Size.
Definition: FontAttribs.h:98
Definition: diagrams_c.h:5
Definition: CellIterators.h:120
Definition: CellIterators.h:70
Definition: CellList.h:151
The storage for pointers to cells.
Definition: CellPointers.h:45
A weak non-owning pointer that becomes null whenever the observed object is destroyed.
Definition: CellPtr.h:480
A class that carries information about the type of a cell.
Definition: Cell.h:93
virtual const wxString & GetName() const =0
The name of the cell type, e.g.
The base class all cell types the worksheet can consist of are derived from.
Definition: Cell.h:142
bool UnBreakUpCells()
Convert all maths objects in this call list into their 2D form.
Definition: Cell.cpp:536
bool ConfigChanged() const
Has the configuration changed since the last recalculation of this cell?
Definition: Cell.h:475
virtual wxString ToMatlab() const
Convert this cell to its Matlab representation.
Definition: Cell.cpp:649
virtual const wxString GetToolTip(wxPoint point) const
Returns the ToolTip this cell provides at a given point.
Definition: Cell.cpp:49
bool InUpdateRegion() const
Is this cell inside the region that is currently drawn?
Definition: Cell.cpp:561
virtual void DrawBoundingBox(wxDC &WXUNUSED(dc), bool all=false)
Draw a rectangle that marks this cell or this list of cells as selected.
Definition: Cell.cpp:589
bool IsBrokenIntoLines() const
Whether this cell is broken into two or more lines.
Definition: Cell.h:885
void SetPen(wxDC *dc, double lineWidth=1.0) const
Sets the drawing pen to the cell's default foreground color.
Definition: Cell.cpp:1106
void CopyCommonData(const Cell &cell)
Copy common data (used when copying a cell)
Definition: Cell.cpp:172
virtual void PasteFromClipboard(bool primary=false)
Paste from the clipboard into this cell.
Definition: Cell.cpp:951
bool IsHidden() const
Whether this cell is not to be drawn.
Definition: Cell.h:742
Range GetCellsInRect(const wxRect &rect) const
Returns the first and last cells within the given rectangle, recursing into the inner cells.
Definition: Cell.cpp:986
virtual size_t GetInnerCellCount() const
The number of inner cells - for use by the iterators.
Definition: Cell.cpp:1429
virtual int GetImageBorderWidth() const
0 for ordinary cells, 1 for slide shows and diagrams displayed with a 1-pixel border
Definition: Cell.h:851
virtual wxString ToOMML() const
Returns the cell's representation as OMML.
Definition: Cell.cpp:864
void SetBigSkip(bool skip)
Tell this cell to cause an additional vertical space.
Definition: Cell.h:515
bool HasBigSkip() const
Does this cell come with an additional vertical space.
Definition: Cell.h:517
wxRect CropToUpdateRegion(wxRect rect) const
The part of the rectangle rect that is in the region that is currently drawn.
Definition: Cell.cpp:219
Cell * GetNextToDraw() const
Get the next cell that needs to be drawn.
Definition: Cell.h:701
CellPtr< GroupCell > m_group
The GroupCell this list of cells belongs to.
Definition: Cell.h:972
virtual wxString ListToMatlab() const
Convert this list to its LaTeX representation.
Definition: Cell.cpp:651
virtual wxString ListToOMML(bool startofline=false) const
Convert this list to an OMML representation.
Definition: Cell.cpp:866
GroupCell * GetGroup() const
Returns the group cell this cell belongs to.
Definition: Cell.cpp:234
virtual bool IsActive() const
Is this editor cell focused?
Definition: Cell.h:838
void ResetSize_RecursivelyList()
Mark all cached size information of this cell list as "to be calculated".
Definition: Cell.cpp:1040
Configuration * GetConfiguration()
Which configuration object is responsible for this cell?
Definition: Cell.h:305
virtual wxString ListToString() const
Returns this cell list's representation as a string.
Definition: Cell.cpp:619
virtual wxRect GetRect(bool wholeList=false) const
Get the smallest rectangle this cell fits in.
Definition: Cell.cpp:552
wxCoord GetHeightList() const
Returns the total height of this line.
Definition: Cell.cpp:272
virtual bool BreakUp()
Try to split this command into lines to make it fit on the screen.
Definition: Cell.cpp:1067
wxCoord GetCenterList() const
Returns the maximum distance between top and center of this line.
Definition: Cell.cpp:250
virtual void SetCurrentPoint(wxPoint point)
Tells this cell where it is placed on the worksheet.
Definition: Cell.h:873
CellPtr< Cell > m_nextToDraw
The next cell in the draw list. This has been factored into Cell temporarily to reduce the change "no...
Definition: Cell.h:975
void ClearToolTip()
Remove this cell's tooltip.
Definition: Cell.cpp:337
wxCoord GetHeight() const
Get the height of this cell.
Definition: Cell.h:360
Cell * GetNext() const
Get the next cell in the list.
Definition: Cell.h:694
virtual void SelectAll()
Select all editable text of this cell.
Definition: Cell.h:808
bool HasValidPosition() const
Is the position valid?
Definition: Cell.cpp:448
int GetLineIndent() const
If this were the beginning of a line: How far do we need to indent it?
Definition: Cell.cpp:463
virtual void SetValue(const wxString &WXUNUSED(text))
Allows to change the text a TextCell contains.
Definition: Cell.h:555
wxCoord Scale_Px(double px) const
Scale font sizes and line widths according to the zoom factor.
Definition: Cell.h:176
bool ContainsPoint(wxPoint point) const
Is a given point inside this cell?
Definition: Cell.h:285
virtual bool IsShortNum() const
True if this cell represents a short number.
Definition: Cell.h:591
CellType GetType() const
Returns the type of this cell.
Definition: Cell.h:412
void SetTextColor(wxDC *dc)
Sets the text color.
Definition: Cell.cpp:1121
void DrawList(wxPoint point, wxDC *dc, wxDC *adc)
Draw this list of cells.
Definition: Cell.cpp:395
virtual bool CanCopy() const
Select Can we copy the editable text of this cell?
Definition: Cell.h:812
virtual wxString ListToMathML(bool startofline=false) const
Convert this list to a MathML representation.
Definition: Cell.cpp:699
virtual wxString ListToTeX() const
Convert this list to its LaTeX representation.
Definition: Cell.cpp:684
Cell * GetPrevious() const
Returns a pointer to the previous cell in the current cell list.
Definition: Cell.h:691
virtual const wxString & GetAltCopyText() const
Get the text set using SetAltCopyText - may be empty.
Definition: Cell.h:913
void BreakUpAndMark()
Break up the internal cells of this cell, and mark it as broken up.
Definition: Cell.cpp:1069
bool GetHidableMultSign() const
Whether this is a hidable multiplication sign.
Definition: Cell.h:898
bool HasHardLineBreak() const
Does this cell begin with a manual linebreak?
Definition: Cell.h:252
unsigned long CellsInListRecursive() const
How many cells does this cell contain?
Definition: Cell.cpp:207
void ResetSize_Recursively()
Mark all cached size information as "to be calculated".
Definition: Cell.cpp:1033
virtual wxString ToString() const
Returns the cell's representation as a string.
Definition: Cell.cpp:603
void SetConfigurationList(Configuration *config)
Tell this cell list to use the configuration object config.
Definition: Cell.cpp:452
void AddToolTip(const wxString &tip)
Add another tooltip to this cell.
Definition: Cell.cpp:364
Cell * last() const
Get the last cell in this list of cells.
Definition: Cell.cpp:1058
virtual void ClearCache()
Clears memory from cached items automatically regenerated when the cell is drawn.
Definition: Cell.h:292
bool GetSuppressMultiplicationDot() const
Do we want to begin this cell with a center dot if it is part of a product?
Definition: Cell.h:895
void ResetSize()
Mark the cached height and width information as "to be calculated".
Definition: Cell.cpp:1045
virtual wxString ListToRTF(bool startofline=false) const
Convert this list to an RTF representation.
Definition: Cell.cpp:895
virtual void SetIsExponent()
Tell this cell to be an exponent.
Definition: Cell.cpp:389
bool GetHighlight() const
Is this cell highlighted (e.G. inside a maxima box)
Definition: Cell.h:537
static wxString RTFescape(wxString, bool MarkDown=false)
Escape a string for RTF.
Definition: Cell.cpp:830
bool HasStaleSize() const
Is the size valid, whether a recalculation is pending or not?
Definition: Cell.cpp:444
void SetHighlight(bool highlight)
Mark this cell as highlighted (e.G. being in a maxima box)
Definition: Cell.h:535
bool HasValidSize() const
Is the size valid and not pending a recalculation?
Definition: Cell.cpp:440
bool IsEditable(bool input=false) const
Is this cell editable?
Definition: Cell.h:754
wxCoord GetCurrentY() const
Get the y position of the top left of this cell.
Definition: Cell.h:458
virtual void SetIsExponentList()
Tell this list of cells to be an exponent.
Definition: Cell.cpp:383
virtual wxString ListToXML() const
Convert this list to a representation fit for saving in a .wxmx file.
Definition: Cell.cpp:953
virtual void SetNextToDraw(Cell *next)
Tells this cell which one should be the next cell to be drawn.
Definition: Cell.h:710
bool BreakLineHere() const
Are we allowed to break a line here?
Definition: Cell.h:249
virtual wxString GetDiffPart() const
Get the part for diff tag support.
Definition: Cell.cpp:978
Range GetListCellsInRect(const wxRect &rect) const
Returns the first and last cells within the given rectangle, without recursing into the inner cells.
Definition: Cell.cpp:993
wxCoord GetCenter() const
Get the distance between the top and the center of this cell.
Definition: Cell.h:383
wxPoint m_currentPoint
The point in the work sheet at which this cell begins.
Definition: Cell.h:949
virtual void Draw(wxPoint point, wxDC *dc, wxDC *antialiassingDC)
Draw this cell.
Definition: Cell.cpp:302
bool DrawThisCell()
Is this cell currently visible in the window?
Definition: Cell.h:342
void SetToolTip(const wxString &tooltip)
Set the tooltip to a given string.
Definition: Cell.cpp:344
virtual void Recalculate(AFontSize fontsize)
Recalculate the size of the cell and the difference between top and center.
Definition: Cell.cpp:416
void ClearCacheList()
Clears the cache of the whole list of cells starting with this one.
Definition: Cell.cpp:202
virtual void Hide(bool hide=true)
Hide this cell. See IsHidden() for details.
Definition: Cell.h:748
virtual void SelectPointText(wxPoint point)
Select the text at point.
Definition: Cell.cpp:947
void SetCurrentPoint(int x, int y)
Tells this cell where it is placed on the worksheet.
Definition: Cell.h:875
void ForceBreakLine(bool force=true)
Insert (or remove) a forced linebreak at the beginning of this cell.
Definition: Cell.h:350
virtual wxString ToXML() const
Convert this cell to a representation fit for saving in a .wxmx file.
Definition: Cell.cpp:695
virtual void SetAltCopyText(const wxString &text)
What should end up if placing this cell on the clipboard?
Definition: Cell.cpp:376
virtual void SelectRectText(wxPoint one, wxPoint two)
Select the text between the two points.
Definition: Cell.cpp:949
virtual wxString ToMathML() const
Convert this cell to a representation fit for saving in a .wxmx file.
Definition: Cell.cpp:697
bool ContainsRect(const wxRect &sm, bool all=true) const
Is a part of this cell inside a certain rectangle?
Definition: Cell.cpp:1018
bool BreakUpCells()
Cell list: Convert 2d math objects bigger than the screen width into linear form.
Definition: Cell.cpp:519
wxString VariablesAndFunctionsList() const
Returns all variable and function names used inside this list of cells.
Definition: Cell.cpp:607
virtual ~Cell()
Delete this list of cells.
Definition: Cell.cpp:71
AFontSize Scale_Px(AFontSize size) const
Scale font sizes and line widths according to the zoom factor.
Definition: Cell.h:181
virtual bool NeedsRecalculation(AFontSize fontSize) const
True, if something that affects the cell size has changed.
Definition: Cell.cpp:242
virtual void SetStyle(TextStyle style)
Sets the TextStyle of this cell.
Definition: Cell.h:842
virtual const CellTypeInfo & GetInfo()=0
Returns the information about this cell's type.
virtual std::unique_ptr< Cell > Copy(GroupCell *group) const =0
Create a copy of this cell.
wxCoord GetLineWidth() const
How many pixels is the current line of this list of cells wide?
Definition: Cell.cpp:285
wxCoord m_height
The height of this cell.
Definition: Cell.h:993
void SetNextToDraw(const std::unique_ptr< T, Del > &ptr)
Tells this cell which one should be the next cell to be drawn.
Definition: Cell.h:720
virtual wxPoint PositionToPoint()
Locates the cursor in the editable text of this cell.
Definition: Cell.h:820
virtual void SetConfiguration(Configuration *config)
Tell this cell to use the configuration object config.
Definition: Cell.cpp:457
void ScheduleRecalculation()
Cause this cell to be recalculated the next time.
Definition: Cell.h:473
virtual wxString GnuplotSource() const
Retrieve the gnuplot source data for this image.
Definition: Cell.h:768
wxCoord GetMaxDrop() const
Returns the maximum distance between center and bottom of this line.
Definition: Cell.cpp:261
static wxString XMLescape(wxString)
Escape a string for XML.
Definition: Cell.cpp:811
virtual bool FirstLineOnlyEditor()
True, if this GroupCell is folded and its editor shows only its first line.
Definition: Cell.cpp:157
wxCoord m_center
The distance between the top and the insertion point of this cell.
Definition: Cell.h:1004
virtual Cell * GetInnerCell(size_t index) const
Retrieve an inner cell with given index which must be less than GetInnerCellCount.
Definition: Cell.cpp:1431
virtual const wxString & GetValue() const
Gets the text this text cell contains.
Definition: Cell.cpp:1119
Configuration * m_configuration
A pointer to the configuration responsible for this worksheet.
Definition: Cell.h:978
int GetWidth() const
Get the width of this cell.
Definition: Cell.h:371
virtual wxString ToTeX() const
Convert this cell to its LaTeX representation.
Definition: Cell.cpp:682
wxPoint GetCurrentPoint() const
Where is this cell placed on the worksheet?
Definition: Cell.h:877
wxCoord m_width
The width of this cell; is recalculated by RecalculateHeight.
Definition: Cell.h:997
virtual void SetFocus(bool WXUNUSED(focus))
Focus this editor cell.
Definition: Cell.h:831
void SoftLineBreak(bool breakLine=true)
Do we want this cell to start with a linebreak?
Definition: Cell.h:230
virtual void ProcessEvent(wxKeyEvent &WXUNUSED(event))
Processes a key event.
Definition: Cell.h:771
wxCoord GetCurrentX() const
Get the x position of the top left of this cell.
Definition: Cell.h:451
virtual void UnbreakList()
Unbreak this line.
Definition: Cell.cpp:1090
bool IsComment() const
Determine if this cell contains text that isn't code.
Definition: Cell.h:726
void ResetSizeList()
Mark the cached height information of the whole list of cells as "to be calculated".
Definition: Cell.cpp:407
static wxString OMML2RTF(wxXmlNode *node)
Converts an OMML tag to the corresponding RTF snippet.
Definition: Cell.cpp:760
virtual void SetType(CellType type)
Sets the text style according to the type.
Definition: Cell.cpp:79
AFontSize m_fontSize_Scaled
The font size is smaller in super- and subscripts.
Definition: Cell.h:1009
virtual Range GetInnerCellsInRect(const wxRect &rect) const
Select the cells inside this cell described by the rectangle rect.
Definition: Cell.cpp:1005
bool IsCompound() const
Do we have an operator in this line - draw () in frac...
Definition: Cell.cpp:596
wxBitmap BitmapFromSVG(wxString svgData, wxSize size)
Renders a bitmap from svgData at the requested size.
Definition: Cell.cpp:135
std::unique_ptr< Cell > CopyList(GroupCell *group) const
Return a copy of the list of cells beginning with this one.
Definition: Cell.cpp:191
virtual void FontsChanged()
To be called if the font has changed.
Definition: Cell.h:1063
virtual bool IsDirty() const
Is this cell marked as "from an old maxima run"?
Definition: Cell.h:824
friend auto OnInner(const C *cell)
Returns an iterable that goes over the inner cells of this cell.
Definition: Cell.h:1122
virtual bool CutToClipboard()
Cut this cell's editable contents to the clipboard.
Definition: Cell.h:804
virtual bool IsOperator() const
Is this cell an operator?
Definition: Cell.h:585
bool IsMath() const
Is this cell possibly output of maxima?
Definition: Cell.cpp:1150
virtual bool CanPopOut() const
Can this cell be popped out interactively in gnuplot?
Definition: Cell.h:762
wxCoord GetDrop() const
Get the distance between the center and the bottom of this cell.
Definition: Cell.h:406
void FontsChangedList()
Tell a whole list of cells that their fonts have changed.
Definition: Cell.cpp:226
virtual bool AddEnding()
Add a semicolon to a code cell, if needed.
Definition: Cell.h:778
const wxString * m_toolTip
This tooltip is owned by us when m_ownsToolTip is true. Otherwise, it points to a "static" string.
Definition: Cell.h:982
virtual bool CopyToClipboard() const
Copy this cell's editable contents to the clipboard.
Definition: Cell.h:798
void SetBrush(wxDC *dc) const
Sets the fill brush to the cell's default foreground color.
Definition: Cell.cpp:1114
const TextStyle & GetTextStyle() const
Get the text style.
Definition: Cell.h:523
virtual void Unbreak()
Undo breaking this cell into multiple lines.
Definition: Cell.cpp:1079
Cell * first() const
Get the first cell in this list of cells.
Definition: Cell.cpp:1049
wxCoord GetFullWidth() const
How many pixels is this list of cells wide, if we don't break it into lines?
Definition: Cell.cpp:274
void RecalculateList(AFontSize fontsize)
Recalculate both width and height of this list of cells.
Definition: Cell.cpp:402
virtual wxString ToRTF() const
Returns the cell's representation as RTF.
Definition: Cell.h:635
virtual wxPoint PositionToPoint(size_t WXUNUSED(pos))
Locates a char in the editable text of this cell.
Definition: Cell.h:816
The configuration storage for the current worksheet.
Definition: Configuration.h:85
std::int_fast32_t CellCfgCnt() const
A counter that increases every time we need to recalculate all worksheet cells.
Definition: Configuration.h:1073
wxCoord Scale_Px(double px) const
Scales a distance [in pixels] according to the zoom factor.
Definition: Configuration.cpp:1396
This class defines what the user sees as input cell.
Definition: EditorCell.h:59
A cell grouping input (and, if there is one, also the output) cell to a foldable item.
Definition: GroupCell.h:74
Definition: CellIterators.h:210
Iterates the inner cells of a cell.
Definition: CellIterators.h:138
Objects deriving from this class can be observed by the CellPtr.
Definition: CellPtr.h:88
A Text cell.
Definition: TextCell.h:38
The canvas that contains the spreadsheet the whole program is about.
Definition: Worksheet.h:95
A struct that allows to specify a region of a cell list.
Definition: Cell.h:567
For the bitmap export we sometimes want to know how big the result will be...
Definition: Cell.h:598