The base class all cell types the worksheet can consist of are derived from. More...

#include <Cell.h>

Inheritance diagram for Cell:

Collaboration diagram for Cell:

Data Structures
struct	Range
	A struct that allows to specify a region of a cell list. More...

struct	SizeInMillimeters
	For the bitmap export we sometimes want to know how big the result will be... More...

Public Member Functions
	Cell (GroupCell group, Configuration config)

virtual std::unique_ptr< Cell >	Copy (GroupCell *group) const =0
	Create a copy of this cell.

virtual const CellTypeInfo &	GetInfo ()=0
	Returns the information about this cell's type.

wxCoord	Scale_Px (double px) const
	Scale font sizes and line widths according to the zoom factor.

AFontSize	Scale_Px (AFontSize size) const
	Scale font sizes and line widths according to the zoom factor.

virtual const wxString	GetToolTip (wxPoint point) const
	Returns the ToolTip this cell provides at a given point.

virtual	~Cell ()
	Delete this list of cells.

unsigned long	CellsInListRecursive () const
	How many cells does this cell contain?

wxRect	CropToUpdateRegion (wxRect rect) const
	The part of the rectangle rect that is in the region that is currently drawn.

bool	InUpdateRegion () const
	Is this cell inside the region that is currently drawn?

void	SoftLineBreak (bool breakLine=true)
	Do we want this cell to start with a linebreak?

bool	BreakUpCells ()
	Cell list: Convert 2d math objects bigger than the screen width into linear form.

bool	UnBreakUpCells ()
	Convert all maths objects in this call list into their 2D form.

void	BreakLines_List ()

int	GetLineIndent () const
	If this were the beginning of a line: How far do we need to indent it?

bool	BreakLineHere () const
	Are we allowed to break a line here?

bool	HasHardLineBreak () const
	Does this cell begin with a manual linebreak?

virtual bool	BreakUp ()
	Try to split this command into lines to make it fit on the screen.

bool	ContainsRect (const wxRect &sm, bool all=true) const
	Is a part of this cell inside a certain rectangle?

bool	ContainsPoint (wxPoint point) const
	Is a given point inside this cell?

virtual void	ClearCache ()
	Clears memory from cached items automatically regenerated when the cell is drawn.

void	ClearCacheList ()
	Clears the cache of the whole list of cells starting with this one.

void	SetConfigurationList (Configuration *config)
	Tell this cell list to use the configuration object config.

virtual void	SetConfiguration (Configuration *config)
	Tell this cell to use the configuration object config.

Configuration *	GetConfiguration ()
	Which configuration object is responsible for this cell?

virtual void	Draw (wxPoint point, wxDC dc, wxDC antialiassingDC)
	Draw this cell.

void	DrawList (wxPoint point, wxDC dc, wxDC adc)
	Draw this list of cells.

void	DrawList (wxDC dc, wxDC adc)

virtual void	DrawBoundingBox (wxDC &WXUNUSED(dc), bool all=false)
	Draw a rectangle that marks this cell or this list of cells as selected.

bool	DrawThisCell (wxPoint point)
	Is this cell currently visible in the window?

bool	DrawThisCell ()
	Is this cell currently visible in the window?

void	ForceBreakLine (bool force=true)
	Insert (or remove) a forced linebreak at the beginning of this cell.

wxCoord	GetHeight () const
	Get the height of this cell.

int	GetWidth () const
	Get the width of this cell.

wxCoord	GetCenter () const
	Get the distance between the top and the center of this cell.

bool	HasValidSize () const
	Is the size valid and not pending a recalculation?

bool	HasStaleSize () const
	Is the size valid, whether a recalculation is pending or not?

bool	HasValidPosition () const
	Is the position valid?

wxCoord	GetDrop () const
	Get the distance between the center and the bottom of this cell.

CellType	GetType () const
	Returns the type of this cell.

wxCoord	GetMaxDrop () const
	Returns the maximum distance between center and bottom of this line.

wxCoord	GetCenterList () const
	Returns the maximum distance between top and center of this line.

wxCoord	GetHeightList () const
	Returns the total height of this line.

wxCoord	GetFullWidth () const
	How many pixels is this list of cells wide, if we don't break it into lines?

wxCoord	GetLineWidth () const
	How many pixels is the current line of this list of cells wide?

wxCoord	GetCurrentX () const
	Get the x position of the top left of this cell.

wxCoord	GetCurrentY () const
	Get the y position of the top left of this cell.

virtual wxRect	GetRect (bool wholeList=false) const
	Get the smallest rectangle this cell fits in.

virtual bool	NeedsRecalculation (AFontSize fontSize) const
	True, if something that affects the cell size has changed.

void	ScheduleRecalculation ()
	Cause this cell to be recalculated the next time.

bool	ConfigChanged () const
	Has the configuration changed since the last recalculation of this cell?

virtual wxString	GetDiffPart () const
	Get the part for diff tag support.

virtual void	Recalculate (AFontSize fontsize)
	Recalculate the size of the cell and the difference between top and center.

void	RecalculateList (AFontSize fontsize)
	Recalculate both width and height of this list of cells.

void	FontsChangedList ()
	Tell a whole list of cells that their fonts have changed.

void	ResetSize_Recursively ()
	Mark all cached size information as "to be calculated".

void	ResetSize_RecursivelyList ()
	Mark all cached size information of this cell list as "to be calculated".

void	ResetSize ()
	Mark the cached height and width information as "to be calculated".

void	ResetSizeList ()
	Mark the cached height information of the whole list of cells as "to be calculated".

void	SetBigSkip (bool skip)
	Tell this cell to cause an additional vertical space.

bool	HasBigSkip () const
	Does this cell come with an additional vertical space.

virtual void	SetType (CellType type)
	Sets the text style according to the type.

const TextStyle &	GetTextStyle () const
	Get the text style.

void	SetPen (wxDC *dc, double lineWidth=1.0) const
	Sets the drawing pen to the cell's default foreground color.

void	SetBrush (wxDC *dc) const
	Sets the fill brush to the cell's default foreground color.

wxColour	GetForegroundColor () const

void	SetHighlight (bool highlight)
	Mark this cell as highlighted (e.G. being in a maxima box)

bool	GetHighlight () const
	Is this cell highlighted (e.G. inside a maxima box)

virtual void	SetIsExponent ()
	Tell this cell to be an exponent.

virtual void	SetIsExponentList ()
	Tell this list of cells to be an exponent.

virtual void	SetValue (const wxString &WXUNUSED(text))
	Allows to change the text a TextCell contains.

virtual const wxString &	GetValue () const
	Gets the text this text cell contains.

virtual const wxString	GetDisplayedString () const

Cell *	first () const
	Get the first cell in this list of cells.

Cell *	last () const
	Get the last cell in this list of cells.

Range	GetCellsInRect (const wxRect &rect) const
	Returns the first and last cells within the given rectangle, recursing into the inner cells.

Range	GetListCellsInRect (const wxRect &rect) const
	Returns the first and last cells within the given rectangle, without recursing into the inner cells.

virtual Range	GetInnerCellsInRect (const wxRect &rect) const
	Select the cells inside this cell described by the rectangle rect.

virtual bool	IsOperator () const
	Is this cell an operator?

bool	IsCompound () const
	Do we have an operator in this line - draw () in frac...

virtual bool	IsShortNum () const
	True if this cell represents a short number.

GroupCell *	GetGroup () const
	Returns the group cell this cell belongs to.

virtual wxString	ListToString () const
	Returns this cell list's representation as a string.

wxString	VariablesAndFunctionsList () const
	Returns all variable and function names used inside this list of cells.

virtual wxString	ListToMatlab () const
	Convert this list to its LaTeX representation.

virtual wxString	ListToTeX () const
	Convert this list to its LaTeX representation.

virtual wxString	ListToXML () const
	Convert this list to a representation fit for saving in a .wxmx file.

virtual wxString	ListToMathML (bool startofline=false) const
	Convert this list to a MathML representation.

virtual wxString	ListToOMML (bool startofline=false) const
	Convert this list to an OMML representation.

virtual wxString	ListToRTF (bool startofline=false) const
	Convert this list to an RTF representation.

virtual wxString	ToString () const
	Returns the cell's representation as a string.

virtual wxString	ToRTF () const
	Returns the cell's representation as RTF.

virtual wxString	ToOMML () const
	Returns the cell's representation as OMML.

virtual wxString	ToMatlab () const
	Convert this cell to its Matlab representation.

virtual wxString	ToTeX () const
	Convert this cell to its LaTeX representation.

virtual wxString	ToXML () const
	Convert this cell to a representation fit for saving in a .wxmx file.

virtual wxString	ToMathML () const
	Convert this cell to a representation fit for saving in a .wxmx file.

virtual void	Unbreak ()
	Undo breaking this cell into multiple lines.

virtual void	UnbreakList ()
	Unbreak this line.

Cell *	GetPrevious () const
	Returns a pointer to the previous cell in the current cell list.

Cell *	GetNext () const
	Get the next cell in the list.

Cell *	GetNextToDraw () const
	Get the next cell that needs to be drawn.

virtual void	SetNextToDraw (Cell *next)
	Tells this cell which one should be the next cell to be drawn.

template<typename T , typename Del , typename std::enable_if< std::is_base_of< Cell, T >::value, bool >::type = true>
void	SetNextToDraw (const std::unique_ptr< T, Del > &ptr)
	Tells this cell which one should be the next cell to be drawn.

bool	IsComment () const
	Determine if this cell contains text that isn't code.

bool	IsHidden () const
	Whether this cell is not to be drawn.

virtual bool	FirstLineOnlyEditor ()
	True, if this GroupCell is folded and its editor shows only its first line.

virtual void	Hide (bool hide=true)
	Hide this cell. See IsHidden() for details.

bool	IsEditable (bool input=false) const
	Is this cell editable?

virtual bool	CanPopOut () const
	Can this cell be popped out interactively in gnuplot?

virtual wxString	GnuplotSource () const
	Retrieve the gnuplot source data for this image.

virtual void	ProcessEvent (wxKeyEvent &WXUNUSED(event))
	Processes a key event.

virtual bool	AddEnding ()
	Add a semicolon to a code cell, if needed.

virtual void	SelectPointText (wxPoint point)
	Select the text at point.

virtual void	SelectRectText (wxPoint one, wxPoint two)
	Select the text between the two points.

virtual void	PasteFromClipboard (bool primary=false)
	Paste from the clipboard into this cell.

virtual bool	CopyToClipboard () const
	Copy this cell's editable contents to the clipboard.

virtual bool	CutToClipboard ()
	Cut this cell's editable contents to the clipboard.

virtual void	SelectAll ()
	Select all editable text of this cell.

virtual bool	CanCopy () const
	Select Can we copy the editable text of this cell?

virtual wxPoint	PositionToPoint (size_t WXUNUSED(pos))
	Locates a char in the editable text of this cell.

virtual wxPoint	PositionToPoint ()
	Locates the cursor in the editable text of this cell.

virtual bool	IsDirty () const
	Is this cell marked as "from an old maxima run"?

virtual void	SwitchCaretDisplay ()

virtual void	SetFocus (bool WXUNUSED(focus))
	Focus this editor cell.

void	SetTextColor (wxDC *dc)
	Sets the text color.

virtual bool	IsActive () const
	Is this editor cell focused?

virtual void	SetStyle (TextStyle style)
	Sets the TextStyle of this cell.

bool	IsMath () const
	Is this cell possibly output of maxima?

virtual int	GetImageBorderWidth () const
	0 for ordinary cells, 1 for slide shows and diagrams displayed with a 1-pixel border

void	CopyCommonData (const Cell &cell)
	Copy common data (used when copying a cell)

std::unique_ptr< Cell >	CopyList (GroupCell *group) const
	Return a copy of the list of cells beginning with this one.

void	ClearToolTip ()
	Remove this cell's tooltip.

void	SetToolTip (const wxString &tooltip)
	Set the tooltip to a given string.

void	SetToolTip (const wxString *toolTip)
	Set the tooltip of this math cell - it must be exist at least as long as the cell does. Translation results behave that way. I.e. it must be a static string!

void	AddToolTip (const wxString &tip)
	Add another tooltip to this cell.

virtual void	SetCurrentPoint (wxPoint point)
	Tells this cell where it is placed on the worksheet.

void	SetCurrentPoint (int x, int y)
	Tells this cell where it is placed on the worksheet.

wxPoint	GetCurrentPoint () const
	Where is this cell placed on the worksheet?

bool	IsBrokenIntoLines () const
	Whether this cell is broken into two or more lines.

bool	GetSuppressMultiplicationDot () const
	Do we want to begin this cell with a center dot if it is part of a product?

void	SetSuppressMultiplicationDot (bool val)

bool	GetHidableMultSign () const
	Whether this is a hidable multiplication sign.

void	SetHidableMultSign (bool val)

virtual void	SetAltCopyText (const wxString &text)
	What should end up if placing this cell on the clipboard?

virtual const wxString &	GetAltCopyText () const
	Get the text set using SetAltCopyText - may be empty.

const wxString &	GetLocalToolTip () const

bool	IsNull () const

bool	HasControlBlock () const

bool	HasOneCellPtr () const

Static Public Member Functions
static wxString	OMML2RTF (wxXmlNode *node)
	Converts an OMML tag to the corresponding RTF snippet.

static wxString	OMML2RTF (wxString ommltext)
	Converts OMML math to RTF math.

static wxString	RTFescape (wxString, bool MarkDown=false)
	Escape a string for RTF.

static wxString	XMLescape (wxString)
	Escape a string for XML.

static std::unique_ptr< Cell >	CopyList (GroupCell group, const Cell cell)
	Return a copy of the given list of cells.

static wxString	wxColor2HtmlString (wxColor col)

static std::unique_ptr< Cell >	MakeVisiblyInvalidCell (GroupCell group, Configuration config)

static size_t	GetLiveInstanceCount ()

static size_t	GetLiveControlBlockInstanceCount ()

Protected Member Functions
void	BreakUpAndMark ()
	Break up the internal cells of this cell, and mark it as broken up.

wxBitmap	BitmapFromSVG (wxString svgData, wxSize size)
	Renders a bitmap from svgData at the requested size.

std::unique_ptr< Cell >	MakeVisiblyInvalidCell () const

virtual size_t	GetInnerCellCount () const
	The number of inner cells - for use by the iterators.

virtual Cell *	GetInnerCell (size_t index) const
	Retrieve an inner cell with given index which must be less than GetInnerCellCount.

Worksheet *	GetWorksheet () const

virtual void	FontsChanged ()
	To be called if the font has changed.

CellPointers *	GetCellPointers () const

Protected Attributes
wxPoint	m_currentPoint {-1, -1}
	The point in the work sheet at which this cell begins.

CellPtr< GroupCell >	m_group
	The GroupCell this list of cells belongs to.

CellPtr< Cell >	m_nextToDraw
	The next cell in the draw list. This has been factored into Cell temporarily to reduce the change "noise" when it will be subsequently removed.

Configuration *	m_configuration
	A pointer to the configuration responsible for this worksheet.

const wxString *	m_toolTip
	This tooltip is owned by us when m_ownsToolTip is true. Otherwise, it points to a "static" string.

wxCoord	m_height = -1
	The height of this cell.

wxCoord	m_width = -1
	The width of this cell; is recalculated by RecalculateHeight.

wxCoord	m_center = -1
	The distance between the top and the insertion point of this cell.

AFontSize	m_fontSize_Scaled = {}
	The font size is smaller in super- and subscripts.

CellType	m_type = MC_TYPE_DEFAULT

TextStyle	m_textStyle = TS_MATH

Friends
class	CellList

class	InnerCellIterator

template<typename C , typename std::enable_if< std::is_base_of< Cell, C >::value, bool >::type >
auto	OnInner (const C *cell)
	Returns an iterable that goes over the inner cells of this cell.

template<typename C , typename std::enable_if< std::is_base_of< Cell, C >::value, bool >::type >
auto	OnInner (C *cell)

Detailed Description

The base class all cell types the worksheet can consist of are derived from.

Every Cell is part of two double-linked lists:

A Cell does have a member m_previous that points to the previous item (or contains a NULL for the head node of the list) and a member named m_next that points to the next cell (or contains a NULL if this is the end node of a list).
And there is m_nextToDraw that contain fractions and similar items as one element if they are drawn as a single 2D object that isn't divided by a line break, but will contain every single element of a fraction as a separate object if the fraction is broken into several lines and therefore displayed in its a linear form.

Also every list of Cells can be a branch of a tree since every math cell contains a pointer to its parent group cell.

Besides the cell types that are directly user visible there are cells for several kinds of items that are displayed in a special way like abs() statements (displayed as horizontal rules), subscripts, superscripts and exponents. Another important concept realized by a class derived from this one is the group cell that groups all things that are foldable in the gui like:

A combination of maxima input with the output, the input prompt and the output label.
A chapter or a section and
Images with their title (or the input cells that generated them)

Attention: Derived classes must test if m_next equals NULL and if it doesn't they have to delete() it.

On systems where wxWidget supports (and is compiled with) accessibility features Cell is derived from wxAccessible which allows every element in the worksheet to identify itself to an eventual screen reader.

Member Function Documentation

◆ AddEnding()

virtual bool Cell::AddEnding ( )

inlinevirtual

Add a semicolon to a code cell, if needed.

Defined in GroupCell and EditorCell

Reimplemented in EditorCell, and GroupCell.

◆ BreakUp()

bool Cell::BreakUp ( )

virtual

Try to split this command into lines to make it fit on the screen.

Return values

true	= This cell was split into lines.

Reimplemented in AbsCell, BoxCell, ConjugateCell, DiffCell, ExptCell, FracCell, FunCell, IntCell, IntervalCell, LimitCell, ListCell, LongNumberCell, NamedBoxCell, ParenCell, SqrtCell, and SumCell.

◆ BreakUpAndMark()

void Cell::BreakUpAndMark ( )

protected

Break up the internal cells of this cell, and mark it as broken up.

Sets the cell's size to 0, as in broken up state the contents of the cell will be displayed in 1D mode while this cell won't be displayed, at all.

◆ BreakUpCells()

bool Cell::BreakUpCells ( )

Cell list: Convert 2d math objects bigger than the screen width into linear form.

Return values

true,if this action has changed the height of cells.

◆ CanCopy()

virtual bool Cell::CanCopy ( ) const

inlinevirtual

Select Can we copy the editable text of this cell?

Reimplemented in EditorCell.

◆ CanPopOut()

virtual bool Cell::CanPopOut ( ) const

inlinevirtual

Can this cell be popped out interactively in gnuplot?

Reimplemented in AnimationCell, ImgCell, and ImgCellBase.

◆ CellsInListRecursive()

unsigned long Cell::CellsInListRecursive ( ) const

How many cells does this cell contain?

The number of cells the current group contains (-1, if no GroupCell)

◆ ClearCache()

virtual void Cell::ClearCache ( )

inlinevirtual

Clears memory from cached items automatically regenerated when the cell is drawn.

The scaled version of the image will be recreated automatically once it is needed.

Reimplemented in AnimationCell, ImgCell, and ImgCellBase.

◆ ClearCacheList()

void Cell::ClearCacheList ( )

Clears the cache of the whole list of cells starting with this one.

For details see ClearCache().

◆ ContainsPoint()

bool Cell::ContainsPoint ( wxPoint point ) const

inline

Is a given point inside this cell?

Parameters

point The point to test for collision with this cell

◆ ContainsRect()

bool Cell::ContainsRect	(	const wxRect &	sm,
		bool	all = `true`
	)		const

Is a part of this cell inside a certain rectangle?

Parameters

sm	The rectangle to test for collision with this cell
all	true means test this cell and the ones that are following it in the list false means test this cell only.

◆ Copy()

virtual std::unique_ptr< Cell > Cell::Copy ( GroupCell * group ) const

pure virtual

Create a copy of this cell.

This method is purely virtual, which means every child class has to define its own Copy() method.

Implemented in AbsCell, AnimationCell, AtCell, BoxCell, ConjugateCell, DiffCell, DigitCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, LongNumberCell, MatrCell, NamedBoxCell, ParenCell, ProductCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, FullTestCell, and ImgCellBase.

◆ CopyToClipboard()

virtual bool Cell::CopyToClipboard ( ) const

inlinevirtual

Copy this cell's editable contents to the clipboard.

Only interesting for EditorCells

Reimplemented in AnimationCell, EditorCell, ImgCell, and ImgCellBase.

◆ CutToClipboard()

virtual bool Cell::CutToClipboard ( )

inlinevirtual

Cut this cell's editable contents to the clipboard.

Only interesting for EditorCells

Reimplemented in EditorCell.

◆ Draw()

void Cell::Draw	(	wxPoint	point,
		wxDC *	dc,
		wxDC *	antialiassingDC
	)

virtual

Draw this cell.

Draw this cell to dc.

Parameters

point The x and y position this cell is drawn at: All top-level cells get their position during recalculation. But for the cells within them the position needs a second step after determining the dimension of the contents of the top-level cell.

Example: The position of the denominator of a fraction can only be determined after the height of denominator and numerator are known.

To make this work each derived class must draw the content of the cell and then call MathCell::Draw(...).

Reimplemented in AbsCell, AtCell, DiffCell, DigitCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, LongNumberCell, MatrCell, ParenCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ DrawBoundingBox()

void Cell::DrawBoundingBox	(	wxDC &	WXUNUSEDdc,
		bool	all = `false`
	)

virtual

Draw a rectangle that marks this cell or this list of cells as selected.

Parameters

all	true: Draw the bounding box around this list of cells false: Draw the bounding box around this cell only
dc	The drawing context the box is drawn in.

◆ DrawList()

void Cell::DrawList	(	wxPoint	point,
		wxDC *	dc,
		wxDC *	adc
	)

Draw this list of cells.

Parameters

point The x and y position this cell is drawn at

◆ DrawThisCell()

bool Cell::DrawThisCell ( wxPoint point )

Is this cell currently visible in the window?

Parameters

point The point to place this cell at

◆ FirstLineOnlyEditor()

bool Cell::FirstLineOnlyEditor ( )

virtual

True, if this GroupCell is folded and its editor shows only its first line.

Reimplemented in GroupCell.

◆ FontsChanged()

virtual void Cell::FontsChanged ( )

inlineprotectedvirtual

To be called if the font has changed.

Reimplemented in TextCell.

◆ ForceBreakLine()

void Cell::ForceBreakLine ( bool force = true )

inline

Insert (or remove) a forced linebreak at the beginning of this cell.

Parameters

force

true: Insert a forced linebreak
false: Remove the forced linebreak

◆ GetAltCopyText()

virtual const wxString & Cell::GetAltCopyText ( ) const

inlinevirtual

Get the text set using SetAltCopyText - may be empty.

Reimplemented in ExptCell, FunCell, LabelCell, SubCell, SubSupCell, SumCell, and TextCell.

◆ GetCenter()

wxCoord Cell::GetCenter ( ) const

inline

Get the distance between the top and the center of this cell.

Remember that (for example with double fractions) the center does not have to be in the middle of a cell even if this object is — by definition — center-aligned.

◆ GetCenterList()

int Cell::GetCenterList ( ) const

Returns the maximum distance between top and center of this line.

Note that the center doesn't need to be exactly in the middle of an object. For a fraction for example the center is exactly at the middle of the horizontal line.

◆ GetCurrentX()

wxCoord Cell::GetCurrentX ( ) const

inline

Get the x position of the top left of this cell.

See m_currentPoint for more details.

◆ GetCurrentY()

wxCoord Cell::GetCurrentY ( ) const

inline

Get the y position of the top left of this cell.

See m_currentPoint for more details.

◆ GetDiffPart()

wxString Cell::GetDiffPart ( ) const

virtual

Get the part for diff tag support.

only ExptCell and SubSupCell override this - and this function seems to be used by fractions that represent an diff() command.

Reimplemented in ExptCell, and SubSupCell.

◆ GetDrop()

wxCoord Cell::GetDrop ( ) const

inline

Get the distance between the center and the bottom of this cell.

Remember that (for example with double fractions) the center does not have to be in the middle of an output cell even if the current object is — by definition — center-aligned.

This value is recalculated by Recalculate

◆ GetHeight()

wxCoord Cell::GetHeight ( ) const

inline

Get the height of this cell.

This value is recalculated by Recalculate()

◆ GetHeightList()

int Cell::GetHeightList ( ) const

Returns the total height of this line.

Returns GetCenterList()+GetMaxDrop()

◆ GetInfo()

virtual const CellTypeInfo & Cell::GetInfo ( )

pure virtual

Returns the information about this cell's type.

Implemented in AbsCell, AnimationCell, AtCell, BoxCell, ConjugateCell, DiffCell, DigitCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, LongNumberCell, MatrCell, NamedBoxCell, ParenCell, ProductCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, VisiblyInvalidCell, FullTestCell, and ImgCellBase.

◆ GetInnerCell()

Cell * Cell::GetInnerCell ( size_t index ) const

protectedvirtual

Retrieve an inner cell with given index which must be less than GetInnerCellCount.

Reimplemented in AbsCell, AtCell, BoxCell, ConjugateCell, DiffCell, ExptCell, FracCell, FunCell, GroupCell, IntCell, IntervalCell, LimitCell, ListCell, LongNumberCell, MatrCell, NamedBoxCell, ParenCell, SqrtCell, SubCell, SubSupCell, and SumCell.

◆ GetInnerCellCount()

size_t Cell::GetInnerCellCount ( ) const

protectedvirtual

The number of inner cells - for use by the iterators.

Reimplemented in AbsCell, AtCell, BoxCell, ConjugateCell, DiffCell, ExptCell, FracCell, FunCell, GroupCell, IntCell, IntervalCell, LimitCell, ListCell, LongNumberCell, MatrCell, NamedBoxCell, ParenCell, SqrtCell, SubCell, SubSupCell, SumCell, and IterArrayCell< N >.

◆ GetInnerCellsInRect()

Cell::Range Cell::GetInnerCellsInRect ( const wxRect & rect ) const

virtual

Select the cells inside this cell described by the rectangle rect.

Reimplemented in GroupCell.

◆ GetLineWidth()

int Cell::GetLineWidth ( ) const

How many pixels is the current line of this list of cells wide?

This command returns the real line width when all line breaks are really performed. See GetFullWidth().

◆ GetMaxDrop()

int Cell::GetMaxDrop ( ) const

Returns the maximum distance between center and bottom of this line.

Note that the center doesn't need to be exactly in the middle of an object. For a fraction for example the center is exactly at the middle of the horizontal line.

◆ GetNextToDraw()

Cell * Cell::GetNextToDraw ( ) const

inline

Get the next cell that needs to be drawn.

In case of potential 2d objects like fractions either the fraction needs to be drawn as a single 2D object or the nominator, the cell containing the "/" and the denominator are pointed to by GetNextToDraw() as single separate objects.

◆ GetRect()

wxRect Cell::GetRect ( bool wholeList = false ) const

virtual

Get the smallest rectangle this cell fits in.

Parameters

all	true: Get the rectangle for this cell and the ones that follow it in the list of cells false: Get the rectangle for this cell only.

Reimplemented in GroupCell.

◆ GetSuppressMultiplicationDot()

bool Cell::GetSuppressMultiplicationDot ( ) const

inline

Do we want to begin this cell with a center dot if it is part of a product?

Maxima will represent a product like (a*b*c) by a list like the following: [*,a,b,c]. This would result us in converting (a*b*c) to the following LaTeX code: \left(\cdot a ß\cdot b \cdot c\right) which obviously is one \cdot too many => we need parenthesis cells to set this flag for the first cell in their "inner cell" list.

◆ GetToolTip()

const wxString Cell::GetToolTip ( wxPoint point ) const

virtual

Returns the ToolTip this cell provides at a given point.

Parameters

point The point in worksheet coordinates, must be inside the cell or else an empty string is returned.

Returns: the tooltip text, or empty string if none.

Reimplemented in AnimationCell, GroupCell, ImgCell, and ImgCellBase.

◆ GetValue()

const wxString & Cell::GetValue ( ) const

virtual

Gets the text this text cell contains.

Reimplemented in EditorCell, and TextCell.

◆ GetWidth()

int Cell::GetWidth ( ) const

inline

Get the width of this cell.

This value is recalculated by Recalculate()

◆ GnuplotSource()

virtual wxString Cell::GnuplotSource ( ) const

inlinevirtual

Retrieve the gnuplot source data for this image.

wxEmptyString means: No such data.

Reimplemented in AnimationCell, ImgCell, and ImgCellBase.

◆ Hide()

virtual void Cell::Hide ( bool hide = true )

inlinevirtual

Hide this cell. See IsHidden() for details.

Reimplemented in GroupCell.

◆ IsActive()

virtual bool Cell::IsActive ( ) const

inlinevirtual

Is this editor cell focused?

Reimplemented in EditorCell.

◆ IsBrokenIntoLines()

bool Cell::IsBrokenIntoLines ( ) const

inline

Whether this cell is broken into two or more lines.

Long abs(), conjugate(), fraction and similar cells can be displayed as 2D objects, but will be displayed in their linear form (and therefore broken into lines) if they end up to be wider than the screen. In this case m_isBrokenIntoLines is true.

◆ IsComment()

bool Cell::IsComment ( ) const

inline

Determine if this cell contains text that isn't code.

Returns: true, if this is a text cell, a title cell, a section, a subsection or a sub(n)section cell.

◆ IsDirty()

virtual bool Cell::IsDirty ( ) const

inlinevirtual

Is this cell marked as "from an old maxima run"?

Reimplemented in EditorCell.

◆ IsEditable()

bool Cell::IsEditable ( bool input = false ) const

inline

Is this cell editable?

Editable cells include comments, code, captions and questions from maxima.

◆ IsHidden()

bool Cell::IsHidden ( ) const

inline

Whether this cell is not to be drawn.

Currently the following items fall into this category:

parenthesis around fractions or similar things that clearly can be recognized as atoms
plus signs within numbers
The output in folded GroupCells

Additionally folded GroupCells are marked as "hidden".

◆ IsOperator()

virtual bool Cell::IsOperator ( ) const

inlinevirtual

Is this cell an operator?

Reimplemented in FracCell, and TextCell.

◆ IsShortNum()

virtual bool Cell::IsShortNum ( ) const

inlinevirtual

True if this cell represents a short number.

Reimplemented in TextCell.

◆ NeedsRecalculation()

bool Cell::NeedsRecalculation ( AFontSize fontSize ) const

virtual

True, if something that affects the cell size has changed.

Reimplemented in EditorCell, and GroupCell.

◆ PasteFromClipboard()

void Cell::PasteFromClipboard ( bool primary = false )

virtual

Paste from the clipboard into this cell.

Parameters

primary Linux has two clipboards: One that automatically stores all selected test and that is pasted on middle-click (true) and the traditional copy-and-paste one (false). This parameter tells which clipboard to use.

Reimplemented in EditorCell.

◆ PositionToPoint()

virtual wxPoint Cell::PositionToPoint ( )

inlinevirtual

Locates the cursor in the editable text of this cell.

Reimplemented in EditorCell.

◆ Recalculate()

void Cell::Recalculate ( AFontSize fontsize )

virtual

Recalculate the size of the cell and the difference between top and center.

Must set: m_height, m_width, m_center.

Parameters

fontsize In exponents, super- and subscripts the font size is reduced. This cell therefore needs to know which font size it has to be drawn at.

Reimplemented in AbsCell, AtCell, DiffCell, DigitCell, EditorCell, ExptCell, FracCell, FunCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, LongNumberCell, MatrCell, ParenCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ RecalculateList()

void Cell::RecalculateList ( AFontSize fontsize )

Recalculate both width and height of this list of cells.

Is faster than a RecalculateHeightList();RecalculateWidths();.

◆ ResetSize_Recursively()

void Cell::ResetSize_Recursively ( )

Mark all cached size information as "to be calculated".

Resets remembered size and position info for this cell and all cells inside it.

Resets cached data like width and the height of the current cell as well as the vertical position of the center. Then repeats this with

◆ Scale_Px() [1/2]

AFontSize Cell::Scale_Px ( AFontSize size ) const

inline

Scale font sizes and line widths according to the zoom factor.

Is used for displaying/printing/exporting of text/maths

◆ Scale_Px() [2/2]

wxCoord Cell::Scale_Px ( double px ) const

inline

Scale font sizes and line widths according to the zoom factor.

Is used for displaying/printing/exporting of text/maths

◆ SelectAll()

virtual void Cell::SelectAll ( )

inlinevirtual

Select all editable text of this cell.

Reimplemented in EditorCell.

◆ SelectPointText()

void Cell::SelectPointText ( wxPoint point )

virtual

Select the text at point.

Reimplemented in EditorCell.

◆ SelectRectText()

void Cell::SelectRectText	(	wxPoint	one,
		wxPoint	two
	)

virtual

Select the text between the two points.

Reimplemented in EditorCell.

◆ SetAltCopyText()

void Cell::SetAltCopyText ( const wxString & text )

virtual

What should end up if placing this cell on the clipboard?

AltCopyTexts for example make sense for subCells: a_n looks like a[n], even if both are lookalikes and the cell therefore needs to know what to put on the clipboard if this cell were copied. They also make sense in many other places we may never have thought about. But since we seriously want to save memory space on the ubiuitous TextCells it might be scary to apply this principle to them, at least if you know that text you copy from the internet to a terminal might contain additional commands with TextSize=0...

Reimplemented in ExptCell, FunCell, SubCell, SubSupCell, SumCell, and TextCell.

◆ SetConfiguration()

void Cell::SetConfiguration ( Configuration * config )

virtual

Tell this cell to use the configuration object config.

Reimplemented in AnimationCell.

◆ SetIsExponent()

void Cell::SetIsExponent ( )

virtual

Tell this cell to be an exponent.

Fractions in exponents are displayed as 1D maths

Reimplemented in FracCell.

◆ SetIsExponentList()

void Cell::SetIsExponentList ( )

virtual

Tell this list of cells to be an exponent.

Fractions in exponents are displayed as 1D maths

◆ SetNextToDraw() [1/2]

virtual void Cell::SetNextToDraw ( Cell * next )

inlinevirtual

Tells this cell which one should be the next cell to be drawn.

If the cell is displayed as 2d object this sets the pointer to the next cell.

If the cell is broken into lines this sets the pointer of the last of the list of cells this cell is displayed as.

Reimplemented in AbsCell, BoxCell, ConjugateCell, DiffCell, FracCell, FunCell, IntCell, IntervalCell, LimitCell, ListCell, LongNumberCell, NamedBoxCell, ParenCell, SqrtCell, and SumCell.

◆ SetNextToDraw() [2/2]

template<typename T , typename Del , typename std::enable_if< std::is_base_of< Cell, T >::value, bool >::type = true>

void Cell::SetNextToDraw ( const std::unique_ptr< T, Del > & ptr )

inline

Tells this cell which one should be the next cell to be drawn.

If the cell is displayed as 2d object this sets the pointer to the next cell.

If the cell is broken into lines this sets the pointer of the last of the list of cells this cell is displayed as.

◆ SetStyle()

virtual void Cell::SetStyle ( TextStyle style )

inlinevirtual

Sets the TextStyle of this cell.

Reimplemented in EditorCell, LabelCell, and TextCell.

◆ SetType()

void Cell::SetType ( CellType type )

virtual

Sets the text style according to the type.

Reimplemented in EditorCell, and TextCell.

◆ SetValue()

virtual void Cell::SetValue ( const wxString & WXUNUSEDtext )

inlinevirtual

Allows to change the text a TextCell contains.

Todo:: Do we ever use this function?

◆ SwitchCaretDisplay()

virtual void Cell::SwitchCaretDisplay ( )

inlinevirtual

Reimplemented in EditorCell.

◆ ToMathML()

wxString Cell::ToMathML ( ) const

virtual

Convert this cell to a representation fit for saving in a .wxmx file.

Reimplemented in AbsCell, AtCell, DiffCell, ExptCell, FracCell, FunCell, IntCell, IntervalCell, LimitCell, ListCell, MatrCell, ParenCell, SqrtCell, SubCell, SubSupCell, SumCell, and TextCell.

◆ ToMatlab()

wxString Cell::ToMatlab ( ) const

virtual

Convert this cell to its Matlab representation.

Reimplemented in AbsCell, AtCell, DiffCell, EditorCell, ExptCell, FracCell, FunCell, ImgCell, IntCell, IntervalCell, LimitCell, ListCell, MatrCell, ParenCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ ToOMML()

wxString Cell::ToOMML ( ) const

virtual

Returns the cell's representation as OMML.

If this method returns wxEmptyString this might mean that this cell is better handled in RTF; The OOML can later be translated to the respective RTF maths commands using OMML2RTF.

Don't know why OMML was implemented in a world that already knows MathML, though.

Reimplemented in AbsCell, AtCell, DiffCell, ExptCell, FracCell, FunCell, IntCell, IntervalCell, LimitCell, ListCell, MatrCell, ParenCell, SqrtCell, SubCell, SubSupCell, SumCell, and TextCell.

◆ ToRTF()

virtual wxString Cell::ToRTF ( ) const

inlinevirtual

Returns the cell's representation as RTF.

If this method returns wxEmptyString this might mean that this cell is better handled in OMML.

Reimplemented in EditorCell, GroupCell, ImgCell, TextCell, and ImgCellBase.

◆ ToString()

wxString Cell::ToString ( ) const

virtual

Returns the cell's representation as a string.

Reimplemented in AbsCell, AtCell, DiffCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, MatrCell, ParenCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ ToTeX()

wxString Cell::ToTeX ( ) const

virtual

Convert this cell to its LaTeX representation.

Reimplemented in AbsCell, AtCell, DiffCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LimitCell, ListCell, MatrCell, ParenCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ ToXML()

wxString Cell::ToXML ( ) const

virtual

Convert this cell to a representation fit for saving in a .wxmx file.

Reimplemented in AbsCell, AtCell, DiffCell, EditorCell, ExptCell, FracCell, FunCell, GroupCell, ImgCell, IntCell, IntervalCell, LabelCell, LimitCell, ListCell, MatrCell, ParenCell, SetCell, SqrtCell, SubCell, SubSupCell, SumCell, TextCell, and ImgCellBase.

◆ Unbreak()

void Cell::Unbreak ( )

virtual

Undo breaking this cell into multiple lines.

Some cells have different representations when they contain a line break. Examples for this are fractions or a set of parenthesis.

This function tries to return a cell to the single-line form.

Reimplemented in SumCell.

◆ UnbreakList()

void Cell::UnbreakList ( )

virtual

Unbreak this line.

Some cells have different representations when they contain a line break. Examples for this are fractions or a set of parenthesis.

This function tries to return a list of cells to the single-line form.

◆ VariablesAndFunctionsList()

wxString Cell::VariablesAndFunctionsList ( ) const

Returns all variable and function names used inside this list of cells.

Used for detecting lookalike chars in function and variable names.

Field Documentation

◆ m_center

wxCoord Cell::m_center = -1

protected

The distance between the top and the insertion point of this cell.

◆ m_currentPoint

wxPoint Cell::m_currentPoint {-1, -1}

protected

The point in the work sheet at which this cell begins.

The begin of a cell is defined as

x=the left border of the cell
y=the vertical center of the cell. Which (per example in the case of a fraction) might not be the physical center but the vertical position of the horizontal line between numerator and denominator.

The current point is recalculated

for GroupCells by GroupCell::RecalculateHeight
for EditorCells by it's GroupCell's RecalculateHeight and
for Cells when they are drawn.

◆ m_height

wxCoord Cell::m_height = -1

protected

The height of this cell.

The documentation for this class was generated from the following files:

src/cells/Cell.h
src/cells/Cell.cpp
src/cells/VisiblyInvalidCell.cpp
src/Worksheet.cpp
src/Worksheet.h
test/unit_tests/TestStubs.cpp

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ AddEnding()

◆ BreakUp()

◆ BreakUpAndMark()

◆ BreakUpCells()

◆ CanCopy()

◆ CanPopOut()

◆ CellsInListRecursive()

◆ ClearCache()

◆ ClearCacheList()

◆ ContainsPoint()

◆ ContainsRect()

◆ Copy()

◆ CopyToClipboard()

◆ CutToClipboard()

◆ Draw()

◆ DrawBoundingBox()

◆ DrawList()

◆ DrawThisCell()

◆ FirstLineOnlyEditor()

◆ FontsChanged()

◆ ForceBreakLine()

◆ GetAltCopyText()

◆ GetCenter()

◆ GetCenterList()

◆ GetCurrentX()

◆ GetCurrentY()

◆ GetDiffPart()

◆ GetDrop()

◆ GetHeight()

◆ GetHeightList()

◆ GetInfo()

◆ GetInnerCell()

◆ GetInnerCellCount()

◆ GetInnerCellsInRect()

◆ GetLineWidth()

◆ GetMaxDrop()

◆ GetNextToDraw()

◆ GetRect()

◆ GetSuppressMultiplicationDot()

◆ GetToolTip()

◆ GetValue()

◆ GetWidth()

◆ GnuplotSource()

◆ Hide()

◆ IsActive()

◆ IsBrokenIntoLines()

◆ IsComment()

◆ IsDirty()

◆ IsEditable()

◆ IsHidden()

◆ IsOperator()

◆ IsShortNum()

◆ NeedsRecalculation()

◆ PasteFromClipboard()

◆ PositionToPoint()

◆ Recalculate()

◆ RecalculateList()

◆ ResetSize_Recursively()

◆ Scale_Px() [1/2]

◆ Scale_Px() [2/2]

◆ SelectAll()

◆ SelectPointText()

◆ SelectRectText()

◆ SetAltCopyText()

◆ SetConfiguration()

◆ SetIsExponent()

◆ SetIsExponentList()

◆ SetNextToDraw() [1/2]

◆ SetNextToDraw() [2/2]

◆ SetStyle()

◆ SetType()

◆ SetValue()