# synfigapp::Action::Base Class Reference

Top-level base class for all actions. More...

`#include <action.h>`

Inheritance diagram for synfigapp::Action::Base:

List of all members.

## Public Member Functions

virtual | ~Base ()
virtual void | perform ()=0
| This function will throw an Action::Error() on failure.
virtual bool | set_param (const synfig::String &, const Param &)
virtual bool | is_ready () const =0
virtual synfig::String | get_name () const =0
virtual synfig::String | get_local_name () const
void | set_param_list (const ParamList &)

## Static Public Member Functions

static synfig::String | get_layer_descriptions (const std::list< synfig::Layer::Handle > layers, synfig::String singular_prefix="", synfig::String plural_prefix="")
static synfig::String | get_layer_descriptions (const std::list< std::pair< synfig::Layer::Handle, int > > layers, synfig::String singular_prefix="", synfig::String plural_prefix="")

## Protected Member Functions

| Base ()

## Detailed Description

Top-level base class for all actions.

An action should implement the following functions:

- static bool is_candidate(const ParamList &x);
  - Checks the ParamList to see if this action could be performed.
- static ParamVocab get_param_vocab();
  - Yields the ParamVocab object which describes what this action needs before it can perform the act.
- static Action::Base* create();
  - Factory for creating this action from a ParamList

## Constructor & Destructor Documentation

synfigapp::Action::Base::Base | ( |  | ) | `[inline, protected]`

virtual synfigapp::Action::Base::~Base | ( |  | ) | `[inline, virtual]`

## Member Function Documentation

virtual void synfigapp::Action::Base::perform | ( |  | ) | `[pure virtual]`

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

Implemented in synfigapp::Action::Super, synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointRemove, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRemove, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::EditModeSet, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::GroupRename, synfigapp::Action::KeyframeAdd, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::LayerActivate, synfigapp::Action::LayerAdd, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetDesc, synfigapp::Action::TimepointsCopy, synfigapp::Action::TimepointsDelete, synfigapp::Action::TimepointsMove, synfigapp::Action::ValueNodeAdd, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeReplace, synfigapp::Action::WaypointAdd, synfigapp::Action::WaypointConnect, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointRemove, synfigapp::Action::WaypointSet, and synfigapp::Action::WaypointSimpleAdd.

virtual bool synfigapp::Action::Base::set_param | ( | const synfig::String & | ,
|  | const Param & |  |
| ) |  |  | `[inline, virtual]`

Reimplemented in synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointRemove, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ActivepointSetSmart, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRemove, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::ColorSet, synfigapp::Action::EditModeSet, synfigapp::Action::GradientSet, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::GroupRename, synfigapp::Action::KeyframeAdd, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::LayerActivate, synfigapp::Action::LayerAdd, synfigapp::Action::LayerDuplicate, synfigapp::Action::LayerEncapsulate, synfigapp::Action::LayerLower, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerRaise, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetDesc, 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::ValueNodeAdd, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::ValueNodeDynamicListRotateOrder, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeReplace, synfigapp::Action::WaypointAdd, synfigapp::Action::WaypointConnect, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointRemove, synfigapp::Action::WaypointSet, synfigapp::Action::WaypointSetSmart, and synfigapp::Action::WaypointSimpleAdd.

Referenced by set_param_list().

virtual bool synfigapp::Action::Base::is_ready | ( |  | ) | const`[pure virtual]`

Implemented in synfigapp::Action::Group, synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointRemove, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ActivepointSetSmart, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRemove, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::ColorSet, synfigapp::Action::EditModeSet, synfigapp::Action::GradientSet, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::GroupRename, synfigapp::Action::KeyframeAdd, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::LayerActivate, synfigapp::Action::LayerAdd, synfigapp::Action::LayerDuplicate, synfigapp::Action::LayerEncapsulate, synfigapp::Action::LayerLower, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerRaise, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetDesc, 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::ValueNodeAdd, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::ValueNodeDynamicListRotateOrder, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeReplace, synfigapp::Action::WaypointAdd, synfigapp::Action::WaypointConnect, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointRemove, synfigapp::Action::WaypointSet, synfigapp::Action::WaypointSetSmart, and synfigapp::Action::WaypointSimpleAdd.

virtual synfig::String synfigapp::Action::Base::get_name | ( |  | ) | const`[pure virtual]`

Implemented in synfigapp::Action::Group.

Referenced by get_local_name().

virtual synfig::String synfigapp::Action::Base::get_local_name | ( |  | ) | const`[inline, virtual]`

References get_name().

void Action::Base::set_param_list | ( | const ParamList & | param_list | ) |

References set_param().

synfig::String Action::Base::get_layer_descriptions | ( | const std::list< synfig::Layer::Handle > | layers,
|  | synfig::String | singular_prefix = `""`,
|  | synfig::String | plural_prefix = `""` |
| ) |  |  | `[static]`

synfig::String Action::Base::get_layer_descriptions | ( | const std::list< std::pair< synfig::Layer::Handle, int > > | layers,
|  | synfig::String | singular_prefix = `""`,
|  | synfig::String | plural_prefix = `""` |
| ) |  |  | `[static]`

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

- action.h
- action.cpp