wxMaxima
FunCell.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 // (C) 2014-2016 Gunter Königsmann <wxMaxima@physikbuch.de>
5 //
6 // This program is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation; either version 2 of the License, or
9 // (at your option) any later version.
10 //
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 //
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 //
21 // SPDX-License-Identifier: GPL-2.0+
22 
23 #ifndef FUNCELL_H
24 #define FUNCELL_H
25 
26 #include "Cell.h"
27 #include <memory>
53 class FunCell final : public Cell
54 {
55 public:
56  FunCell(GroupCell *group, Configuration *config,
57  std::unique_ptr<Cell> &&name, std::unique_ptr<Cell> &&arg);
58  FunCell(GroupCell *group, const FunCell &cell);
59  std::unique_ptr<Cell> Copy(GroupCell *group) const override;
60  const CellTypeInfo &GetInfo() override;
61 
62  size_t GetInnerCellCount() const override { return 2; }
63  // cppcheck-suppress objectIndex
64  Cell *GetInnerCell(size_t index) const override { return (&m_nameCell)[index].get(); }
65 
66  void Recalculate(AFontSize fontsize) override;
67 
68  void Draw(wxPoint point, wxDC *dc, wxDC *antialiassingDC) override;
69 
70  wxString ToMathML() const override;
71  wxString ToMatlab() const override;
72  wxString ToOMML() const override;
73  wxString ToString() const override;
74  wxString ToTeX() const override;
75  wxString ToXML() const override;
76 
77  void SetAltCopyText(const wxString &text) override { m_altCopyText = text; }
78  const wxString &GetAltCopyText() const override { return m_altCopyText; }
79 
80  bool BreakUp() override;
81 
82  void SetNextToDraw(Cell *next) override;
83 
84 private:
86  wxString m_altCopyText;
87 
88  // The pointers below point to inner cells and must be kept contiguous.
89  // ** This is the draw list order. All pointers must be the same:
90  // ** either Cell * or std::unique_ptr<Cell>. NO OTHER TYPES are allowed.
91  std::unique_ptr<Cell> m_nameCell;
92  std::unique_ptr<Cell> m_argCell;
93  // The pointers above point to inner cells and must be kept contiguous.
94 
95 //** Bitfield objects (0 bytes)
96 //**
97  static void InitBitFields_FunCell()
98  { // Keep the initialization order below same as the order
99  // of bit fields in this class!
100  }
101 };
102 
103 #endif // FUNCELL_H
The definition of the base class of all cells the worksheet consists of.
A Type-Safe Fixed-Point Font Size.
Definition: FontAttribs.h:98
A class that carries information about the type of a cell.
Definition: Cell.h:93
The base class all cell types the worksheet can consist of are derived from.
Definition: Cell.h:142
The configuration storage for the current worksheet.
Definition: Configuration.h:95
FunCell represents a maxima function no special visual representation exists for.
Definition: FunCell.h:54
const CellTypeInfo & GetInfo() override
Returns the information about this cell's type.
wxString ToXML() const override
Convert this cell to a representation fit for saving in a .wxmx file.
Definition: FunCell.cpp:137
void Recalculate(AFontSize fontsize) override
Recalculate the size of the cell and the difference between top and center.
Definition: FunCell.cpp:56
void SetNextToDraw(Cell *next) override
Tells this cell which one should be the next cell to be drawn.
Definition: FunCell.cpp:167
wxString ToMatlab() const override
Convert this cell to its Matlab representation.
Definition: FunCell.cpp:93
size_t GetInnerCellCount() const override
The number of inner cells - for use by the iterators.
Definition: FunCell.h:62
wxString ToTeX() const override
Convert this cell to its LaTeX representation.
Definition: FunCell.cpp:102
std::unique_ptr< Cell > Copy(GroupCell *group) const override
Create a copy of this cell.
const wxString & GetAltCopyText() const override
Get the text set using SetAltCopyText - may be empty.
Definition: FunCell.h:78
Cell * GetInnerCell(size_t index) const override
Retrieve an inner cell with given index which must be less than GetInnerCellCount.
Definition: FunCell.h:64
wxString ToOMML() const override
Returns the cell's representation as OMML.
Definition: FunCell.cpp:152
wxString ToMathML() const override
Convert this cell to a representation fit for saving in a .wxmx file.
Definition: FunCell.cpp:145
wxString ToString() const override
Returns the cell's representation as a string.
Definition: FunCell.cpp:85
void Draw(wxPoint point, wxDC *dc, wxDC *antialiassingDC) override
Draw this cell.
Definition: FunCell.cpp:74
void SetAltCopyText(const wxString &text) override
What should end up if placing this cell on the clipboard?
Definition: FunCell.h:77
bool BreakUp() override
Try to split this command into lines to make it fit on the screen.
Definition: FunCell.cpp:156
A cell grouping input (and, if there is one, also the output) cell to a foldable item.
Definition: GroupCell.h:74