myscript::iink::MathSolverController Class Reference

#include <MathSolverController.h>

Public Member Functions
virtual	~MathSolverController ()=default
virtual std::vector< String >	getAvailableActions (const String &blockId, std::shared_ptr< ParameterSet > overrideConfiguration=nullptr)=0
virtual String	getActionOutput (const String &blockId, const String &action, MimeType mimeType, std::shared_ptr< ParameterSet > overrideConfiguration=nullptr)=0
virtual void	applyAction (const String &blockId, const String &action, std::shared_ptr< ParameterSet > overrideConfiguration=nullptr)=0

Detailed Description

The MathSolverController allows to configure and run math operations on an editor.

See also

Editor.

OffscreenEditor.

Since

4.0

Constructor & Destructor Documentation

~MathSolverController()

virtual myscript::iink::MathSolverController::~MathSolverController ( )

virtualdefault

Member Function Documentation

getAvailableActions()

virtual std::vector<String> myscript::iink::MathSolverController::getAvailableActions ( const String &  blockId, std::shared_ptr< ParameterSet >  overrideConfiguration = nullptr  )

pure virtual

Returns the available actions for the specified block.

Note

following limitation applies: the part managed by the associated editor must be a "Raw Content" and the specified block must be a "Math" block.

Parameters

blockId	the identifier of the block.
overrideConfiguration	the extra configuration used.

Returns

an array of the available actions.

Exceptions

std::invalid_argument	when blockId is invalid.
std::invalid_argument	when overrideConfiguration is invalid.
std::runtime_error	when associated part type is not "Raw Content" or block type is not "Math".

getActionOutput()

virtual String myscript::iink::MathSolverController::getActionOutput ( const String &  blockId, const String &  action, MimeType  mimeType, std::shared_ptr< ParameterSet >  overrideConfiguration = nullptr  )

pure virtual

Returns the output for the given action and the specified block.

Note

following limitation applies: the part managed by the associated editor must be a "Raw Content" and the specified block must be a "Math" block.

Parameters

blockId	the identifier of the block.
action	the action operated by the math solver.
mimeType	the MIME type that specifies the output format, either JIIX or LATEX.
overrideConfiguration	the extra configuration used.

Returns

a string representing the output formatted with the given MIME type.

Exceptions

std::invalid_argument	when blockId is invalid.
std::invalid_argument	when action is invalid
std::invalid_argument	when the specified MIME type is not supported.
std::invalid_argument	when overrideConfiguration is invalid.
std::runtime_error	when associated part type is not "Raw Content" or block type is not "Math".

applyAction()

virtual void myscript::iink::MathSolverController::applyAction ( const String &  blockId, const String &  action, std::shared_ptr< ParameterSet >  overrideConfiguration = nullptr  )

pure virtual

Applies the solved action of the specified block to the rendering.

Note

following limitation applies: incompatible with Offscreen interactivity service.

Parameters

blockId	the identifier of the block.
action	the action used by the math solver.
overrideConfiguration	the extra configuration used.

Exceptions

std::invalid_argument	when blockId is invalid.
std::invalid_argument	when action is invalid.
std::invalid_argument	when overrideConfiguration is invalid.
std::runtime_error	when associated part type is not "Raw Content" or block type is not "Math".
std::runtime_error	when associated with an offscreen editor.

---

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

• iink/MathSolverController.h