# synfigapp::Action Namespace Reference

## Classes

class | Error
| Exception class, thrown when redoing or undoing an action. More...
class | Base
| Top-level base class for all actions. More...
class | Undoable
| Undoable Action Base Class. More...
class | CanvasSpecific
| Action base class for canvas-specific actions. More...
class | Super
| Super-Action base class for actions composed of several other actions. More...
class | Group
struct | BookEntry
class | CandidateList
class | Main
class | Param
| Action Parameter. More...
class | ParamList
class | ParamDesc
class | ParamVocab
class | PassiveGrouper
| Passive action grouping class. More...
class | System
class | ActivepointAdd
class | ActivepointRemove
class | ActivepointSet
class | ActivepointSetOff
class | ActivepointSetOn
class | ActivepointSetSmart
class | ActivepointSimpleAdd
class | BLinePointTangentMerge
class | BLinePointTangentSplit
class | CanvasAdd
class | CanvasDescriptionSet
class | CanvasIdSet
class | CanvasNameSet
class | CanvasRemove
class | CanvasRendDescSet
class | ColorSet
class | ColorSetFromOC
class | ColorSetFromFC
class | EditModeSet
class | GradientSet
class | GroupAddLayers
class | GroupRemove
class | GroupRemoveLayers
class | GroupRename
class | KeyframeAdd
class | KeyframeDuplicate
class | KeyframeRemove
class | KeyframeSet
class | KeyframeSetDelta
class | KeyframeWaypointSet
class | LayerActivate
class | LayerAdd
class | LayerDuplicate
class | LayerEncapsulate
class | LayerLower
class | LayerMove
class | LayerParamConnect
class | LayerParamDisconnect
class | LayerParamSet
class | LayerRaise
class | LayerRemove
class | LayerSetDesc
class | TimepointsCopy
class | TimepointsDelete
class | TimepointsMove
class | ValueDescBLineLink
class | ValueDescConnect
class | ValueDescConvert
class | ValueDescDisconnect
class | ValueDescExport
class | ValueDescLink
class | ValueDescSet
class | ValueNodeAdd
class | ValueNodeConstSet
class | ValueNodeDynamicListInsert
class | ValueNodeDynamicListInsertSmart
class | ValueNodeDynamicListLoop
class | ValueNodeDynamicListRemove
class | ValueNodeDynamicListRemoveSmart
class | ValueNodeDynamicListRotateOrder
class | ValueNodeDynamicListUnLoop
class | ValueNodeLinkConnect
class | ValueNodeLinkDisconnect
class | ValueNodeRemove
class | ValueNodeRename
class | ValueNodeReplace
class | WaypointAdd
class | WaypointConnect
class | WaypointDisconnect
class | WaypointRemove
class | WaypointSet
class | WaypointSetSmart
class | WaypointSimpleAdd

## Typedefs

typedef Action::Base *(* | Factory )()
typedef bool(* | CandidateChecker )(const ParamList &x)
typedef ParamVocab(* | GetParamVocab )()
typedef etl::handle< Base > | Handle
typedef std::list< etl::handle < Action::Undoable > > | ActionList
typedef std::map < synfig::String, BookEntry > | Book
typedef std::list< etl::handle < Action::Undoable > > | Stack

## Enumerations

enum | Category { CATEGORY_NONE = 0, CATEGORY_LAYER = (1<<0), CATEGORY_CANVAS = (1<<1), CATEGORY_WAYPOINT = (1<<2), CATEGORY_ACTIVEPOINT = (1<<3), CATEGORY_VALUEDESC = (1<<4), CATEGORY_VALUENODE = (1<<5), CATEGORY_KEYFRAME = (1<<6), CATEGORY_GROUP = (1<<7), CATEGORY_BEZIER = (1<<8), CATEGORY_OTHER = (1<<12), CATEGORY_DRAG = (1<<24), CATEGORY_HIDDEN = (1<<31), CATEGORY_ALL = (~0)-(1<<31) }

## Functions

Category | operator| (Category lhs, Category rhs)
Book & | book ()
Handle | create (const synfig::String &name)
CandidateList | compile_candidate_list (const ParamList &param_list, Category category=CATEGORY_ALL)
| Compiles a list of potential candidate actions with the given param_list and category.
bool | candidate_check (const ParamVocab &param_vocab, const ParamList &param_list)

## Typedef Documentation

typedef Action::Base*(* synfigapp::Action::Factory)()

typedef bool(* synfigapp::Action::CandidateChecker)(const ParamList &x)

typedef ParamVocab(* synfigapp::Action::GetParamVocab)()

typedef etl::handle<Base> synfigapp::Action::Handle

typedef std::list< etl::handle<Action::Undoable> > synfigapp::Action::ActionList

typedef std::map<synfig::String,BookEntry> synfigapp::Action::Book

typedef std::list< etl::handle<Action::Undoable> > synfigapp::Action::Stack

## Enumeration Type Documentation

enum synfigapp::Action::Category

Enumerator:

  CATEGORY_NONE |
  CATEGORY_LAYER |
  CATEGORY_CANVAS |
  CATEGORY_WAYPOINT |
  CATEGORY_ACTIVEPOINT |
  CATEGORY_VALUEDESC |
  CATEGORY_VALUENODE |
  CATEGORY_KEYFRAME |
  CATEGORY_GROUP |
  CATEGORY_BEZIER |
  CATEGORY_OTHER |
  CATEGORY_DRAG |
  CATEGORY_HIDDEN |
  CATEGORY_ALL | All categories (EXCEPT HIDDEN).

## Function Documentation

Category synfigapp::Action::operator| | ( | Category | lhs,
|  | Category | rhs |
| ) |  |  | `[inline]`

Action::Book & synfigapp::Action::book | ( |  | ) |

References book_.

Referenced by compile_candidate_list(), create(), studio::Dock_Layers::Dock_Layers(), synfigapp::CanvasInterface::import(), init_ui_manager(), studio::Instance::make_param_menu(), studio::Instance::process_action(), and studio::RenderSettings::RenderSettings().

Action::Handle synfigapp::Action::create | ( | const synfig::String & | name | ) |

Todo:
  perhaps we should throw something instead?

References book().

Referenced by studio::Instance::add_actions_to_group(), synfigapp::CanvasInterface::add_layer_to(), studio::StateManager::add_state(), synfigapp::CanvasInterface::add_value_node(), studio::App::App(), synfigapp::CanvasInterface::auto_export(), synfigapp::CanvasInterface::change_value(), studio::LayerActionManager::clear(), studio::KeyframeActionManager::clear(), studio::GroupActionManager::clear(), synfigapp::CanvasInterface::convert(), studio::App::dialog_paragraph(), studio::Dock_History::Dock_History(), studio::Dock_LayerGroups::Dock_LayerGroups(), studio::Dock_Layers::Dock_Layers(), studio::Dock_PalEdit::Dock_PalEdit(), edit_several_waypoints(), synfigapp::Instance::find_canvas_interface(), studio::Instance::find_canvas_view(), get_paragraph(), studio::IconController::get_tool_cursor(), studio::IconController::IconController(), studio::Dock_Layers::init_canvas_view_vfunc(), studio::Dock_LayerGroups::init_canvas_view_vfunc(), studio::Dock_Keyframes::init_canvas_view_vfunc(), studio::Dock_Children::init_canvas_view_vfunc(), init_ui_manager(), studio::Instance::Instance(), studio::IPC::IPC(), studio::LayerActionManager::LayerActionManager(), studio::App::new_instance(), synfigapp::Action::WaypointDisconnect::perform(), synfigapp::Action::ValueNodeLinkDisconnect::perform(), synfigapp::Action::WaypointSetSmart::prepare(), synfigapp::Action::ValueNodeDynamicListRotateOrder::prepare(), synfigapp::Action::ValueNodeDynamicListRemoveSmart::prepare(), synfigapp::Action::ValueNodeDynamicListInsertSmart::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::LayerEncapsulate::prepare(), synfigapp::Action::LayerDuplicate::prepare(), synfigapp::Action::KeyframeSetDelta::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(), synfigapp::Action::ActivepointSetOff::prepare(), studio::Widget_Timeslider::redraw(), studio::Widget_Gradient::redraw(), studio::RedBlueLevelSelector::redraw(), studio::BlackLevelSelector::redraw(), studio::GammaPattern::redraw(), studio::WorkArea::refresh(), studio::KeyframeActionManager::refresh(), studio::GroupActionManager::refresh(), studio::render_color_to_window(), studio::render_gradient_to_window(), studio::render_time_point_to_window(), studio::Renderer_Timecode::render_vfunc(), studio::Renderer_Guides::render_vfunc(), studio::Renderer_Grid::render_vfunc(), studio::Renderer_Ducks::render_vfunc(), studio::Renderer_Dragbox::render_vfunc(), studio::Renderer_Canvas::render_vfunc(), studio::Renderer_BBox::render_vfunc(), studio::CellRenderer_TimeTrack::render_vfunc(), synfigapp::CanvasInterface::set_description(), synfigapp::CanvasInterface::set_id(), synfigapp::CanvasInterface::set_mode(), studio::LayerTree::set_model(), studio::LayerGroupTree::set_model(), studio::KeyframeTree::set_model(), synfigapp::CanvasInterface::set_name(), synfigapp::CanvasInterface::set_rend_desc(), studio::KeyframeTreeStore::set_value_impl(), and set_waypoint_model().

Action::CandidateList synfigapp::Action::compile_candidate_list | ( | const ParamList & | param_list,
|  | Category | category = `CATEGORY_ALL` |
| ) |  |  |

Compiles a list of potential candidate actions with the given param_list and category.

References book().

Referenced by studio::Instance::add_actions_to_group(), and studio::Instance::add_actions_to_menu().

bool synfigapp::Action::candidate_check | ( | const ParamVocab & | param_vocab,
|  | const ParamList & | param_list |
| ) |  |  |

Referenced by synfigapp::Action::WaypointSimpleAdd::is_candidate(), synfigapp::Action::WaypointSetSmart::is_candidate(), synfigapp::Action::WaypointSet::is_candidate(), synfigapp::Action::WaypointRemove::is_candidate(), synfigapp::Action::WaypointDisconnect::is_candidate(), synfigapp::Action::WaypointConnect::is_candidate(), synfigapp::Action::WaypointAdd::is_candidate(), synfigapp::Action::ValueNodeReplace::is_candidate(), synfigapp::Action::ValueNodeRename::is_candidate(), synfigapp::Action::ValueNodeRemove::is_candidate(), synfigapp::Action::ValueNodeLinkDisconnect::is_candidate(), synfigapp::Action::ValueNodeLinkConnect::is_candidate(), synfigapp::Action::ValueNodeDynamicListUnLoop::is_candidate(), synfigapp::Action::ValueNodeDynamicListRotateOrder::is_candidate(), synfigapp::Action::ValueNodeDynamicListRemoveSmart::is_candidate(), synfigapp::Action::ValueNodeDynamicListRemove::is_candidate(), synfigapp::Action::ValueNodeDynamicListLoop::is_candidate(), synfigapp::Action::ValueNodeDynamicListInsertSmart::is_candidate(), synfigapp::Action::ValueNodeDynamicListInsert::is_candidate(), synfigapp::Action::ValueNodeConstSet::is_candidate(), synfigapp::Action::ValueNodeAdd::is_candidate(), synfigapp::Action::ValueDescSet::is_candidate(), synfigapp::Action::ValueDescLink::is_candidate(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescConvert::is_candidate(), synfigapp::Action::ValueDescConnect::is_candidate(), synfigapp::Action::ValueDescBLineLink::is_candidate(), synfigapp::Action::TimepointsMove::is_candidate(), synfigapp::Action::TimepointsDelete::is_candidate(), synfigapp::Action::TimepointsCopy::is_candidate(), synfigapp::Action::LayerSetDesc::is_candidate(), synfigapp::Action::LayerRemove::is_candidate(), synfigapp::Action::LayerRaise::is_candidate(), synfigapp::Action::LayerParamSet::is_candidate(), synfigapp::Action::LayerParamDisconnect::is_candidate(), synfigapp::Action::LayerParamConnect::is_candidate(), synfigapp::Action::LayerMove::is_candidate(), synfigapp::Action::LayerLower::is_candidate(), synfigapp::Action::LayerEncapsulate::is_candidate(), synfigapp::Action::LayerDuplicate::is_candidate(), synfigapp::Action::LayerAdd::is_candidate(), synfigapp::Action::LayerActivate::is_candidate(), synfigapp::Action::KeyframeWaypointSet::is_candidate(), synfigapp::Action::KeyframeSetDelta::is_candidate(), synfigapp::Action::KeyframeSet::is_candidate(), synfigapp::Action::KeyframeRemove::is_candidate(), synfigapp::Action::KeyframeDuplicate::is_candidate(), synfigapp::Action::KeyframeAdd::is_candidate(), synfigapp::Action::GroupRename::is_candidate(), synfigapp::Action::GroupRemoveLayers::is_candidate(), synfigapp::Action::GroupRemove::is_candidate(), synfigapp::Action::GroupAddLayers::is_candidate(), synfigapp::Action::GradientSet::is_candidate(), synfigapp::Action::EditModeSet::is_candidate(), synfigapp::Action::ColorSet::is_candidate(), synfigapp::Action::CanvasRendDescSet::is_candidate(), synfigapp::Action::CanvasRemove::is_candidate(), synfigapp::Action::CanvasNameSet::is_candidate(), synfigapp::Action::CanvasIdSet::is_candidate(), synfigapp::Action::CanvasDescriptionSet::is_candidate(), synfigapp::Action::CanvasAdd::is_candidate(), synfigapp::Action::BLinePointTangentSplit::is_candidate(), synfigapp::Action::BLinePointTangentMerge::is_candidate(), synfigapp::Action::ActivepointSimpleAdd::is_candidate(), synfigapp::Action::ActivepointSetSmart::is_candidate(), synfigapp::Action::ActivepointSetOn::is_candidate(), synfigapp::Action::ActivepointSetOff::is_candidate(), synfigapp::Action::ActivepointSet::is_candidate(), synfigapp::Action::ActivepointRemove::is_candidate(), and synfigapp::Action::ActivepointAdd::is_candidate().