synfigapp::Action::Base Class Reference

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

#include <action.h>

Inheritance diagram for synfigapp::Action::Base:

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	get_param (const synfig::String &, 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 ( )

inlineprotected

virtual synfigapp::Action::Base::~Base ( )

inlinevirtual

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::LayerPaint, synfigapp::Action::KeyframeSet, synfigapp::Action::TimepointsMove, synfigapp::Action::TimepointsCopy, synfigapp::Action::WaypointAdd, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::GroupRename, synfigapp::Action::TimepointsDelete, synfigapp::Action::ValueNodeStaticListInsert, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointSet, synfigapp::Action::WaypointSimpleAdd, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::WaypointConnect, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerParamSetStatic, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetExcludeFromRendering, synfigapp::Action::ValueDescSetInterpolation, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeStaticListRemove, synfigapp::Action::WaypointRemove, synfigapp::Action::ActivepointRemove, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasMetadataSet, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::LayerParamUnSetStatic, synfigapp::Action::LayerSetDesc, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeConstSetStatic, synfigapp::Action::ValueNodeConstUnSetStatic, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeStaticListLoop, synfigapp::Action::ValueNodeStaticListUnLoop, synfigapp::Action::CanvasMetadataErase, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeToggl, synfigapp::Action::LayerActivate, synfigapp::Action::ValueNodeReplace, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::ValueNodeAdd, synfigapp::Action::KeyframeAdd, synfigapp::Action::LayerAdd, synfigapp::Action::CanvasRemove, synfigapp::Action::LayerFit, and synfigapp::Action::EditModeSet.

virtual bool synfigapp::Action::Base::set_param ( const synfig::String &  , const Param &    )

inlinevirtual

Reimplemented in synfigapp::Action::LayerPaint, synfigapp::Action::BLinePointTangentMergeAngle, synfigapp::Action::BLinePointTangentSplitAngle, synfigapp::Action::ValueDescLinkOpposite, synfigapp::Action::BLinePointTangentMergeRadius, synfigapp::Action::BLinePointTangentSplitRadius, synfigapp::Action::ValueDescLink, synfigapp::Action::KeyframeSet, synfigapp::Action::TimepointsMove, synfigapp::Action::ActivepointSetSmart, synfigapp::Action::WaypointAdd, synfigapp::Action::WaypointSetSmart, synfigapp::Action::TimepointsCopy, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::GroupRename, synfigapp::Action::ValueNodeStaticListInsert, synfigapp::Action::ValueNodeStaticListRemoveSmart, synfigapp::Action::TimepointsDelete, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointSet, synfigapp::Action::WaypointSimpleAdd, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::ValueDescSet, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::WaypointConnect, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerParamSetStatic, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetExcludeFromRendering, synfigapp::Action::ValueDescBLineLink, synfigapp::Action::ValueDescSetInterpolation, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeStaticListInsertSmart, synfigapp::Action::ValueNodeStaticListRemove, synfigapp::Action::WaypointRemove, synfigapp::Action::ActivepointRemove, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasMetadataSet, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::LayerEncapsulate, synfigapp::Action::LayerParamUnSetStatic, synfigapp::Action::ValueDescExport, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeConstSetStatic, synfigapp::Action::ValueNodeConstUnSetStatic, synfigapp::Action::ValueNodeDynamicListRotateOrder, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeStaticListLoop, synfigapp::Action::ValueNodeStaticListUnLoop, synfigapp::Action::CanvasMetadataErase, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::LayerActivate, synfigapp::Action::LayerEncapsulateSwitch, synfigapp::Action::LayerSetDesc, synfigapp::Action::ValueNodeReplace, synfigapp::Action::ValueNodeStaticListRotateOrder, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::ColorSet, synfigapp::Action::GradientSet, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeToggl, synfigapp::Action::LayerAddFrame, synfigapp::Action::LayerZDepthRangeSet, synfigapp::Action::ValueDescConvert, synfigapp::Action::ValueDescCreateChildBone, synfigapp::Action::ValueNodeAdd, synfigapp::Action::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::KeyframeAdd, synfigapp::Action::LayerAdd, synfigapp::Action::LayerCopy, synfigapp::Action::LayerDuplicate, synfigapp::Action::ValueDescBoneLink, synfigapp::Action::ValueDescConnect, synfigapp::Action::ValueDescResetPose, synfigapp::Action::ValueDescSkeletonLink, synfigapp::Action::CanvasRemove, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::LayerFit, synfigapp::Action::ValueDescDisconnect, synfigapp::Action::ValueDescRemoveSmart, synfigapp::Action::EditModeSet, synfigapp::Action::LayerLower, synfigapp::Action::LayerRaise, synfigapp::Action::LayerEmbed, synfigapp::Action::LayerExtract, synfigapp::Action::LayerResetPose, and synfigapp::Action::LayerMakeBLine.

virtual bool synfigapp::Action::Base::get_param ( const synfig::String &  , Param &    )

inlinevirtual

Reimplemented in synfigapp::Action::ValueNodeRename, and synfigapp::Action::LayerSetDesc.

virtual bool synfigapp::Action::Base::is_ready ( ) const

pure virtual

Implemented in synfigapp::Action::Group, synfigapp::Action::LayerPaint, synfigapp::Action::BLinePointTangentMergeAngle, synfigapp::Action::BLinePointTangentSplitAngle, synfigapp::Action::ValueDescLinkOpposite, synfigapp::Action::BLinePointTangentMergeRadius, synfigapp::Action::BLinePointTangentSplitRadius, synfigapp::Action::ValueDescLink, synfigapp::Action::KeyframeSet, synfigapp::Action::TimepointsMove, synfigapp::Action::ActivepointSetSmart, synfigapp::Action::WaypointAdd, synfigapp::Action::WaypointSetSmart, synfigapp::Action::TimepointsCopy, synfigapp::Action::ValueNodeDynamicListInsert, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ActivepointAdd, synfigapp::Action::ActivepointSet, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ActivepointSimpleAdd, synfigapp::Action::GroupRename, synfigapp::Action::ValueNodeStaticListInsert, synfigapp::Action::ValueNodeStaticListRemoveSmart, synfigapp::Action::TimepointsDelete, synfigapp::Action::WaypointDisconnect, synfigapp::Action::WaypointSet, synfigapp::Action::WaypointSimpleAdd, synfigapp::Action::GroupAddLayers, synfigapp::Action::GroupRemove, synfigapp::Action::LayerMove, synfigapp::Action::LayerParamConnect, synfigapp::Action::ValueDescSet, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::WaypointConnect, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::LayerParamDisconnect, synfigapp::Action::LayerParamSet, synfigapp::Action::LayerParamSetStatic, synfigapp::Action::LayerRemove, synfigapp::Action::LayerSetExcludeFromRendering, synfigapp::Action::ValueDescBLineLink, synfigapp::Action::ValueDescSetInterpolation, synfigapp::Action::ValueNodeDynamicListLoop, synfigapp::Action::ValueNodeDynamicListRemove, synfigapp::Action::ValueNodeDynamicListUnLoop, synfigapp::Action::ValueNodeLinkConnect, synfigapp::Action::ValueNodeRemove, synfigapp::Action::ValueNodeRename, synfigapp::Action::ValueNodeStaticListInsertSmart, synfigapp::Action::ValueNodeStaticListRemove, synfigapp::Action::WaypointRemove, synfigapp::Action::ActivepointRemove, synfigapp::Action::CanvasAdd, synfigapp::Action::CanvasMetadataSet, synfigapp::Action::GroupRemoveLayers, synfigapp::Action::LayerEncapsulate, synfigapp::Action::LayerParamUnSetStatic, synfigapp::Action::LayerSetDesc, synfigapp::Action::ValueDescExport, synfigapp::Action::ValueNodeConstSet, synfigapp::Action::ValueNodeConstSetStatic, synfigapp::Action::ValueNodeConstUnSetStatic, synfigapp::Action::ValueNodeDynamicListRotateOrder, synfigapp::Action::ValueNodeLinkDisconnect, synfigapp::Action::ValueNodeStaticListLoop, synfigapp::Action::ValueNodeStaticListUnLoop, synfigapp::Action::CanvasMetadataErase, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::LayerActivate, synfigapp::Action::LayerEncapsulateSwitch, synfigapp::Action::ValueNodeReplace, synfigapp::Action::ValueNodeStaticListRotateOrder, synfigapp::Action::CanvasDescriptionSet, synfigapp::Action::CanvasIdSet, synfigapp::Action::CanvasNameSet, synfigapp::Action::CanvasRendDescSet, synfigapp::Action::ColorSet, synfigapp::Action::GradientSet, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeToggl, synfigapp::Action::LayerAddFrame, synfigapp::Action::LayerZDepthRangeSet, synfigapp::Action::ValueDescConvert, synfigapp::Action::ValueDescCreateChildBone, synfigapp::Action::ValueNodeAdd, synfigapp::Action::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::KeyframeAdd, synfigapp::Action::LayerAdd, synfigapp::Action::LayerCopy, synfigapp::Action::LayerDuplicate, synfigapp::Action::ValueDescBoneLink, synfigapp::Action::ValueDescConnect, synfigapp::Action::ValueDescResetPose, synfigapp::Action::ValueDescSkeletonLink, synfigapp::Action::CanvasRemove, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::LayerFit, synfigapp::Action::ValueDescDisconnect, synfigapp::Action::ValueDescRemoveSmart, synfigapp::Action::EditModeSet, synfigapp::Action::LayerLower, synfigapp::Action::LayerRaise, synfigapp::Action::LayerEmbed, synfigapp::Action::LayerExtract, synfigapp::Action::LayerResetPose, and synfigapp::Action::LayerMakeBLine.

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

inlinevirtual

Reimplemented in synfigapp::Action::LayerSetExcludeFromRendering.

References get_name().

void Action::Base::set_param_list

(

const ParamList &

param_list

)

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