cadabra::ActionAddCell Class Reference

Description

Add a cell to the notebook.

#include <Actions.hh>

Inheritance diagram for cadabra::ActionAddCell:

Public Types
enum class	Position { before , after , child }

Public Member Functions
	ActionAddCell (DataCell, DataCell::id_t ref_, Position pos_, bool activate=false)
virtual	~ActionAddCell ()
virtual void	execute (DocumentThread &, GUIBase &) override
	Perform the action.
virtual void	revert (DocumentThread &, GUIBase &) override
	Revert the change to the DTree document and the GUI.
virtual bool	undoable () const override
	Can this action be undone?
Public Member Functions inherited from cadabra::ActionBase
	ActionBase (DataCell::id_t ref_id)

Private Attributes
DataCell	newcell
DTree::iterator	newref
Position	pos
int	child_num
bool	activate
bool	is_replacement
bool	is_input_form

Additional Inherited Members
Public Attributes inherited from cadabra::ActionBase
DataCell::id_t	ref_id
std::function< void()>	callback
	If you want a callback once this action has finished, set it here before queuing.
Protected Attributes inherited from cadabra::ActionBase
DTree::iterator	ref

Member Enumeration Documentation

Position

enum class cadabra::ActionAddCell::Position

strong

Enumerator
before
after
child

Constructor & Destructor Documentation

ActionAddCell()

ActionAddCell::ActionAddCell	(	DataCell	cell,
		DataCell::id_t	ref_,
		Position	pos_,
		bool	activate = false
	)

~ActionAddCell()

virtual cadabra::ActionAddCell::~ActionAddCell ( )

inlinevirtual

Member Function Documentation

execute()

void ActionAddCell::execute ( DocumentThread &  cl, GUIBase &    )

overridevirtual

Perform the action.

This should update both the document tree data structure and the GUI. The latter is updated by calling relevant methods on the GUIBase object passed in.

The base class just looks up the cell given its id_t. If your action does not refer to a cell at all, you do not need to call the base class execute.

Reimplemented from cadabra::ActionBase.

revert()

void ActionAddCell::revert ( DocumentThread &  , GUIBase &    )

overridevirtual

Revert the change to the DTree document and the GUI.

Implements cadabra::ActionBase.

undoable()

bool ActionAddCell::undoable ( ) const

overridevirtual

Can this action be undone?

Reimplemented from cadabra::ActionBase.

Member Data Documentation

activate

bool cadabra::ActionAddCell::activate

private

child_num

int cadabra::ActionAddCell::child_num

private

is_input_form

bool cadabra::ActionAddCell::is_input_form

private

is_replacement

bool cadabra::ActionAddCell::is_replacement

private

newcell

DataCell cadabra::ActionAddCell::newcell

private

newref

DTree::iterator cadabra::ActionAddCell::newref

private

pos

Position cadabra::ActionAddCell::pos

private

---

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

• client_server/Actions.hh
• client_server/Actions.cc