# synfigapp::Action::Super Class Reference

Super-Action base class for actions composed of several other actions. More...

`#include <action.h>`

Inheritance diagram for synfigapp::Action::Super:

List of all members.

## Public Member Functions

ActionList & | action_list ()
const ActionList & | action_list () const
virtual void | prepare ()=0
void | clear ()
bool | first_time () const
void | add_action (etl::handle< Undoable > action)
void | add_action_front (etl::handle< Undoable > action)
virtual void | perform ()
| This function will throw an Action::Error() on failure.
virtual void | undo ()
| This function will throw an Action::Error() on failure.

## Detailed Description

Super-Action base class for actions composed of several other actions.

Actions deriving from this class should only implement prepare(), and NOT implement perform() or undo().

## Member Function Documentation

ActionList& synfigapp::Action::Super::action_list | ( |  | ) | `[inline]`

Referenced by clear().

const ActionList& synfigapp::Action::Super::action_list | ( |  | ) | const`[inline]`

virtual void synfigapp::Action::Super::prepare | ( |  | ) | `[pure virtual]`

Implemented in synfigapp::Action::Group, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ActivepointSetSmart, synfigapp::Action::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::ColorSet, synfigapp::Action::GradientSet, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::LayerDuplicate, synfigapp::Action::LayerEncapsulate, synfigapp::Action::LayerLower, synfigapp::Action::LayerRaise, synfigapp::Action::TimepointsCopy, synfigapp::Action::TimepointsDelete, synfigapp::Action::TimepointsMove, synfigapp::Action::ValueDescBLineLink, synfigapp::Action::ValueDescConnect, synfigapp::Action::ValueDescConvert, synfigapp::Action::ValueDescDisconnect, synfigapp::Action::ValueDescExport, synfigapp::Action::ValueDescLink, synfigapp::Action::ValueDescSet, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::ValueNodeDynamicListRotateOrder, and synfigapp::Action::WaypointSetSmart.

Referenced by perform().

void synfigapp::Action::Super::clear | ( |  | ) | `[inline]`

References action_list().

Referenced by synfigapp::Action::WaypointSetSmart::prepare(), synfigapp::Action::ValueNodeDynamicListRotateOrder::prepare(), synfigapp::Action::ValueNodeDynamicListRemoveSmart::prepare(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescLink::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConvert::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::TimepointsMove::prepare(), synfigapp::Action::TimepointsDelete::prepare(), synfigapp::Action::TimepointsCopy::prepare(), synfigapp::Action::LayerRaise::prepare(), synfigapp::Action::LayerLower::prepare(), synfigapp::Action::KeyframeWaypointSet::prepare(), synfigapp::Action::KeyframeSetDelta::prepare(), synfigapp::Action::KeyframeSet::prepare(), synfigapp::Action::KeyframeRemove::prepare(), synfigapp::Action::KeyframeDuplicate::prepare(), synfigapp::Action::GradientSet::prepare(), synfigapp::Action::ColorSet::prepare(), synfigapp::Action::BLinePointTangentSplit::prepare(), synfigapp::Action::BLinePointTangentMerge::prepare(), synfigapp::Action::ActivepointSetSmart::prepare(), synfigapp::Action::ActivepointSetOn::prepare(), and synfigapp::Action::ActivepointSetOff::prepare().

bool synfigapp::Action::Super::first_time | ( |  | ) | const`[inline]`

Referenced by synfigapp::Action::ValueNodeDynamicListInsertSmart::prepare(), synfigapp::Action::LayerEncapsulate::prepare(), and synfigapp::Action::LayerDuplicate::prepare().

void Super::add_action | ( | etl::handle< Undoable > | action | ) |

References synfigapp::Action::CanvasSpecific::get_canvas(), and synfigapp::Action::CanvasSpecific::set_canvas().

Referenced by synfigapp::Action::WaypointSetSmart::prepare(), synfigapp::Action::ValueNodeDynamicListRotateOrder::prepare(), synfigapp::Action::ValueNodeDynamicListRemoveSmart::prepare(), synfigapp::Action::ValueNodeDynamicListInsertSmart::prepare(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::LayerEncapsulate::prepare(), synfigapp::Action::KeyframeSetDelta::prepare(), synfigapp::Action::BLinePointTangentSplit::prepare(), and synfigapp::Action::BLinePointTangentMerge::prepare().

void Super::add_action_front | ( | etl::handle< Undoable > | action | ) |

References synfigapp::Action::CanvasSpecific::get_canvas(), and synfigapp::Action::CanvasSpecific::set_canvas().

Referenced by synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescLink::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConvert::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::TimepointsMove::prepare(), synfigapp::Action::TimepointsDelete::prepare(), synfigapp::Action::TimepointsCopy::prepare(), synfigapp::Action::LayerRaise::prepare(), synfigapp::Action::LayerLower::prepare(), synfigapp::Action::LayerDuplicate::prepare(), synfigapp::Action::GradientSet::prepare(), synfigapp::Action::ColorSet::prepare(), synfigapp::Action::ActivepointSetSmart::prepare(), synfigapp::Action::ActivepointSetOn::prepare(), and synfigapp::Action::ActivepointSetOff::prepare().

void Super::perform | ( |  | ) | `[virtual]`

This function will throw an Action::Error() on failure.

Implements synfigapp::Action::Base.

Reimplemented in synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::TimepointsCopy, synfigapp::Action::TimepointsDelete, and synfigapp::Action::TimepointsMove.

References synfigapp::Action::Error::get_desc(), synfigapp::Action::Error::get_type(), synfigapp::Action::CanvasSpecific::is_dirty(), prepare(), and synfigapp::Action::CanvasSpecific::set_dirty().

Referenced by synfigapp::Action::TimepointsMove::perform(), synfigapp::Action::TimepointsDelete::perform(), synfigapp::Action::TimepointsCopy::perform(), synfigapp::Action::KeyframeSetDelta::perform(), synfigapp::Action::KeyframeSet::perform(), synfigapp::Action::KeyframeRemove::perform(), and synfigapp::Action::KeyframeDuplicate::perform().

void Super::undo | ( |  | ) | `[virtual]`

This function will throw an Action::Error() on failure.

Implements synfigapp::Action::Undoable.

Reimplemented in synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, and synfigapp::Action::KeyframeSetDelta.

References synfigapp::Action::CanvasSpecific::is_dirty(), and synfigapp::Action::CanvasSpecific::set_dirty().

Referenced by synfigapp::Action::KeyframeSetDelta::undo(), synfigapp::Action::KeyframeSet::undo(), synfigapp::Action::KeyframeRemove::undo(), and synfigapp::Action::KeyframeDuplicate::undo().

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

- action.h
- action.cpp