cadabra::ActionInsertText Class Reference

Description

Add a text string (can be just a single character) at the point of the cursor.

This action is assumed to be triggered from a user change to the GUI cells, so will not update the GUI itself, only the underlying DTree. However, the revert method will need to update the GUI representation.

#include <Actions.hh>

Inheritance diagram for cadabra::ActionInsertText:

Public Member Functions
	ActionInsertText (DataCell::id_t ref_id, int pos, const std::string &)
virtual	~ActionInsertText ()
virtual void	execute (DocumentThread &, GUIBase &) override
	Perform the action. More...
virtual void	revert (DocumentThread &, GUIBase &) override
	Revert the change to the DTree document and the GUI. More...
Public Member Functions inherited from cadabra::ActionBase
	ActionBase (DataCell::id_t ref_id)
virtual bool	undoable () const
	Can this action be undone? More...

Private Attributes
DTree::iterator	this_cell
int	insert_pos
std::string	text

Additional Inherited Members
Public Attributes inherited from cadabra::ActionBase
DataCell::id_t	ref_id
Protected Attributes inherited from cadabra::ActionBase
DTree::iterator	ref

Constructor & Destructor Documentation

ActionInsertText()

ActionInsertText::ActionInsertText	(	DataCell::id_t	ref_id,
		int	pos,
		const std::string &	content
	)

~ActionInsertText()

virtual cadabra::ActionInsertText::~ActionInsertText ( )

inlinevirtual

Member Function Documentation

execute()

void ActionInsertText::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.

Reimplemented from cadabra::ActionBase.

revert()

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

overridevirtual

Revert the change to the DTree document and the GUI.

Implements cadabra::ActionBase.

Member Data Documentation

insert_pos

int cadabra::ActionInsertText::insert_pos

private

text

std::string cadabra::ActionInsertText::text

private

this_cell

DTree::iterator cadabra::ActionInsertText::this_cell

private

---

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

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