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:

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.
Public Member Functions inherited from synfigapp::Action::Undoable
bool	is_active () const
Public Member Functions inherited from synfigapp::Action::Base
virtual	~Base ()
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 &)
Public Member Functions inherited from synfigapp::Action::CanvasSpecific
void	set_canvas (synfig::Canvas::Handle x)
void	set_canvas_interface (etl::loose_handle< synfigapp::CanvasInterface > x)
synfig::Canvas::Handle	get_canvas () const
etl::loose_handle < synfigapp::CanvasInterface >	get_canvas_interface () const
virtual bool	set_param (const synfig::String &name, const Param &)
virtual bool	get_param (const synfig::String &, Param &)
virtual bool	is_ready () const
EditMode	get_edit_mode () const
void	set_edit_mode (EditMode x)
bool	is_dirty () const
void	set_dirty (bool x=true)

Additional Inherited Members
Static Public Member Functions inherited from synfigapp::Action::Base
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="")
Static Public Member Functions inherited from synfigapp::Action::CanvasSpecific
static ParamVocab	get_param_vocab ()
Protected Member Functions inherited from synfigapp::Action::Undoable
	Undoable ()
Protected Member Functions inherited from synfigapp::Action::CanvasSpecific
	CanvasSpecific (const synfig::Canvas::Handle &canvas)
	CanvasSpecific ()
virtual	~CanvasSpecific ()

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::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::WaypointSetSmart, synfigapp::Action::TimepointsCopy, synfigapp::Action::ValueNodeDynamicListInsertSmart, synfigapp::Action::ActivepointSetOff, synfigapp::Action::ActivepointSetOn, synfigapp::Action::ValueNodeStaticListRemoveSmart, synfigapp::Action::TimepointsDelete, synfigapp::Action::ValueDescSet, synfigapp::Action::ValueNodeDynamicListRemoveSmart, synfigapp::Action::KeyframeWaypointSet, synfigapp::Action::ValueDescBLineLink, synfigapp::Action::ValueNodeStaticListInsertSmart, synfigapp::Action::LayerEncapsulate, synfigapp::Action::ValueDescExport, synfigapp::Action::ValueNodeDynamicListRotateOrder, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::LayerEncapsulateSwitch, synfigapp::Action::ValueNodeStaticListRotateOrder, 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::BLinePointTangentMerge, synfigapp::Action::BLinePointTangentSplit, synfigapp::Action::LayerCopy, synfigapp::Action::LayerDuplicate, synfigapp::Action::ValueDescBoneLink, synfigapp::Action::ValueDescConnect, synfigapp::Action::ValueDescResetPose, synfigapp::Action::ValueDescSkeletonLink, synfigapp::Action::KeyframeSetDelta, synfigapp::Action::ValueDescDisconnect, synfigapp::Action::LayerLower, synfigapp::Action::LayerRaise, synfigapp::Action::ValueDescRemoveSmart, synfigapp::Action::LayerEmbed, synfigapp::Action::LayerExtract, and synfigapp::Action::LayerResetPose.

void synfigapp::Action::Super::clear ( )

inline

References action_list().

bool synfigapp::Action::Super::first_time ( ) const

inline

void Super::add_action

(

etl::handle< Undoable >

action

)

References synfigapp::Action::CanvasSpecific::get_canvas().

void Super::add_action_front

(

etl::handle< Undoable >

action

)

References synfigapp::Action::CanvasSpecific::get_canvas().

void Super::perform ( )

virtual

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

Implements synfigapp::Action::Base.

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

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

Referenced by synfigapp::Action::KeyframeToggl::perform().

void Super::undo ( )

virtual

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

Implements synfigapp::Action::Undoable.

Reimplemented in synfigapp::Action::KeyframeSet, synfigapp::Action::KeyframeDuplicate, synfigapp::Action::KeyframeRemove, synfigapp::Action::KeyframeToggl, and synfigapp::Action::LayerCopy.

References synfigapp::Action::CanvasSpecific::is_dirty().

Referenced by synfigapp::Action::KeyframeToggl::undo().

---

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

• action.h
• action.cpp