# synfigapp::ValueDesc Class Reference

`#include <value_desc.h>`

List of all members.

## Public Member Functions

bool | operator== (const ValueDesc &rhs) const
bool | operator!= (const ValueDesc &rhs) const
| ValueDesc (synfig::Layer::Handle layer, const synfig::String &param_name)
| ValueDesc (synfig::Layer::LooseHandle layer, const synfig::String &param_name)
| ValueDesc (synfig::LinkableValueNode::Handle parent_value_node, int index)
| ValueDesc (synfig::ValueNode_Animated::Handle parent_value_node, synfig::Time waypoint_time)
| ValueDesc (synfig::Canvas::Handle canvas, const synfig::String &name)
| ValueDesc (synfig::ValueNode_Const::Handle parent_value_node)
| ValueDesc ()
bool | is_valid () const
| operator bool () const
bool | parent_is_layer_param () const
bool | parent_is_value_node () const
bool | parent_is_linkable_value_node () const
bool | parent_is_value_node_const () const
bool | parent_is_waypoint () const
bool | parent_is_canvas () const
bool | is_value_node () const
bool | is_const () const
synfig::Layer::Handle | get_layer () const
const synfig::String & | get_param_name () const
synfig::ValueNode::Handle | get_parent_value_node () const
int | get_index () const
synfig::Time | get_waypoint_time () const
const synfig::String & | get_value_node_id () const
synfig::Canvas::Handle | get_canvas () const
synfig::ValueNode::Handle | get_value_node () const
synfig::ValueBase | get_value (synfig::Time time=0) const
synfig::ValueBase::Type | get_value_type () const
bool | is_exported () const
synfig::String | get_description (bool show_exported_name=true) const

## Constructor & Destructor Documentation

synfigapp::ValueDesc::ValueDesc | ( | synfig::Layer::Handle | layer,
|  | const synfig::String & | param_name |
| ) |  |  | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( | synfig::Layer::LooseHandle | layer,
|  | const synfig::String & | param_name |
| ) |  |  | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( | synfig::LinkableValueNode::Handle | parent_value_node,
|  | int | index |
| ) |  |  | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( | synfig::ValueNode_Animated::Handle | parent_value_node,
|  | synfig::Time | waypoint_time |
| ) |  |  | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( | synfig::Canvas::Handle | canvas,
|  | const synfig::String & | name |
| ) |  |  | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( | synfig::ValueNode_Const::Handle | parent_value_node | ) | `[inline]`

synfigapp::ValueDesc::ValueDesc | ( |  | ) | `[inline]`

## Member Function Documentation

bool synfigapp::ValueDesc::operator== | ( | const ValueDesc & | rhs | ) | const`[inline]`

References canvas, index, layer, name, and parent_value_node.

Referenced by operator!=().

bool synfigapp::ValueDesc::operator!= | ( | const ValueDesc & | rhs | ) | const`[inline]`

References operator==().

bool synfigapp::ValueDesc::is_valid | ( |  | ) | const`[inline]`

Referenced by edit_several_waypoints(), studio::Instance::make_param_menu(), and operator bool().

synfigapp::ValueDesc::operator bool | ( |  | ) | const`[inline]`

References is_valid().

bool synfigapp::ValueDesc::parent_is_layer_param | ( |  | ) | const`[inline]`

Referenced by calc_duck_guid(), synfigapp::CanvasInterface::generate_param_list(), get_description(), get_layer(), get_param_name(), get_time_offset_from_vdesc(), get_value(), get_value_node(), guid_string(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescConnect::is_candidate(), is_const(), is_value_node(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

bool synfigapp::ValueDesc::parent_is_value_node | ( |  | ) | const`[inline]`

Referenced by synfigapp::CanvasInterface::generate_param_list(), get_description(), get_parent_value_node(), get_times_from_vdesc(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescBLineLink::is_candidate(), synfigapp::Action::ActivepointSetSmart::is_candidate(), synfigapp::Action::ActivepointSetOn::is_candidate(), synfigapp::Action::ActivepointSetOff::is_candidate(), is_value_node(), studio::Instance::make_param_menu(), parent_is_linkable_value_node(), parent_is_value_node_const(), parent_is_waypoint(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::recurse_valuedesc(), synfigapp::Action::ActivepointSetSmart::set_param(), synfigapp::Action::ActivepointSetOn::set_param(), and synfigapp::Action::ActivepointSetOff::set_param().

bool synfigapp::ValueDesc::parent_is_linkable_value_node | ( |  | ) | const`[inline]`

References parent_is_value_node().

Referenced by get_description(), get_index(), get_value_node(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

bool synfigapp::ValueDesc::parent_is_value_node_const | ( |  | ) | const`[inline]`

References parent_is_value_node().

Referenced by get_description(), get_value(), get_value_node(), and is_const().

bool synfigapp::ValueDesc::parent_is_waypoint | ( |  | ) | const`[inline]`

References parent_is_value_node().

Referenced by get_description(), get_value_node(), get_waypoint_time(), synfigapp::Action::ValueDescDisconnect::prepare(), and synfigapp::Action::ValueDescConnect::prepare().

bool synfigapp::ValueDesc::parent_is_canvas | ( |  | ) | const`[inline]`

Referenced by synfigapp::CanvasInterface::generate_param_list(), get_description(), get_value_node(), get_value_node_id(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescDisconnect::is_candidate(), is_value_node(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), and studio::CanvasTreeStore::set_row().

bool synfigapp::ValueDesc::is_value_node | ( |  | ) | const`[inline]`

References parent_is_canvas(), parent_is_layer_param(), and parent_is_value_node().

Referenced by _process_value_desc(), studio::Duckmatic::add_to_ducks(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), studio::Duck::get_data_guid(), get_value(), studio::LayerParamTreeStore::get_value_vfunc(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescDisconnect::is_candidate(), is_exported(), studio::Instance::make_param_menu(), synfigapp::Action::KeyframeSetDelta::perform(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescConvert::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), studio::CanvasTreeStore::refresh_row(), studio::CanvasTreeStore::set_row(), and synfigapp::Action::KeyframeSetDelta::undo().

bool synfigapp::ValueDesc::is_const | ( |  | ) | const`[inline]`

References parent_is_layer_param(), and parent_is_value_node_const().

Referenced by studio::Dialog_Gradient::edit(), synfigapp::CanvasInterface::generate_param_list(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescExport::prepare(), and synfigapp::Action::ValueDescConvert::prepare().

synfig::Layer::Handle synfigapp::ValueDesc::get_layer | ( |  | ) | const`[inline]`

References parent_is_layer_param().

Referenced by studio::Duckmatic::add_to_ducks(), calc_duck_guid(), synfigapp::CanvasInterface::generate_param_list(), get_description(), get_time_offset_from_vdesc(), guid_string(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescConnect::is_candidate(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

const synfig::String& synfigapp::ValueDesc::get_param_name | ( |  | ) | const`[inline]`

References parent_is_layer_param().

Referenced by calc_duck_guid(), synfigapp::CanvasInterface::generate_param_list(), get_description(), guid_string(), synfigapp::Action::ValueDescDisconnect::is_candidate(), synfigapp::Action::ValueDescConnect::is_candidate(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), and synfigapp::Action::ValueDescBLineLink::prepare().

synfig::ValueNode::Handle synfigapp::ValueDesc::get_parent_value_node | ( |  | ) | const`[inline]`

References parent_is_value_node().

Referenced by synfigapp::CanvasInterface::generate_param_list(), get_description(), get_times_from_vdesc(), synfigapp::Action::ValueDescBLineLink::is_candidate(), synfigapp::Action::ActivepointSetSmart::is_candidate(), synfigapp::Action::ActivepointSetOn::is_candidate(), synfigapp::Action::ActivepointSetOff::is_candidate(), synfigapp::ActiveTimeInfo::operator<(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::recurse_valuedesc(), synfigapp::Action::ActivepointSetSmart::set_param(), synfigapp::Action::ActivepointSetOn::set_param(), and synfigapp::Action::ActivepointSetOff::set_param().

int synfigapp::ValueDesc::get_index | ( |  | ) | const`[inline]`

References parent_is_linkable_value_node().

Referenced by get_description(), get_times_from_vdesc(), synfigapp::ActiveTimeInfo::operator<(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::recurse_valuedesc(), synfigapp::Action::ValueDescBLineLink::set_param(), synfigapp::Action::ActivepointSetSmart::set_param(), synfigapp::Action::ActivepointSetOn::set_param(), and synfigapp::Action::ActivepointSetOff::set_param().

synfig::Time synfigapp::ValueDesc::get_waypoint_time | ( |  | ) | const`[inline]`

References parent_is_waypoint().

Referenced by synfigapp::Action::ValueDescDisconnect::prepare(), and synfigapp::Action::ValueDescConnect::prepare().

const synfig::String& synfigapp::ValueDesc::get_value_node_id | ( |  | ) | const`[inline]`

References parent_is_canvas().

synfig::Canvas::Handle synfigapp::ValueDesc::get_canvas | ( |  | ) | const`[inline]`

Referenced by synfigapp::CanvasInterface::change_value(), and studio::CanvasTreeStore::set_row().

synfig::ValueNode::Handle synfigapp::ValueDesc::get_value_node | ( |  | ) | const`[inline]`

References parent_is_canvas(), parent_is_layer_param(), parent_is_linkable_value_node(), parent_is_value_node_const(), and parent_is_waypoint().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_to_ducks(), calc_duck_guid(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), studio::Duck::get_data_guid(), get_description(), get_times_from_vdesc(), get_value(), get_value_type(), studio::LayerParamTreeStore::get_value_vfunc(), studio::CanvasTreeStore::get_value_vfunc(), guid_string(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescDisconnect::is_candidate(), is_exported(), studio::Instance::make_param_menu(), synfigapp::Action::KeyframeSetDelta::perform(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescDisconnect::prepare(), synfigapp::Action::ValueDescConvert::prepare(), synfigapp::Action::ValueDescConnect::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::KeyframeSetDelta::prepare(), studio::CanvasTreeStore::rebuild_row(), synfigapp::recurse_valuedesc(), studio::CanvasTreeStore::refresh_row(), studio::CellRenderer_TimeTrack::render_vfunc(), studio::CanvasTreeStore::set_row(), studio::Dialog_Waypoint::set_value_desc(), synfigapp::Action::KeyframeSetDelta::undo(), synfigapp::CanvasInterface::waypoint_duplicate(), and synfigapp::CanvasInterface::waypoint_remove().

synfig::ValueBase synfigapp::ValueDesc::get_value | ( | synfig::Time | time = `0` | ) | const`[inline]`

References get_value_node(), is_value_node(), parent_is_layer_param(), and parent_is_value_node_const().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::change_value(), studio::Dialog_Gradient::edit(), edit_several_waypoints(), synfigapp::CanvasInterface::generate_param_list(), get_time_offset_from_vdesc(), get_times_from_vdesc(), get_value_type(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescSet::prepare(), synfigapp::Action::ValueDescExport::prepare(), and synfigapp::Action::ValueDescConvert::prepare().

synfig::ValueBase::Type synfigapp::ValueDesc::get_value_type | ( |  | ) | const`[inline]`

References get_value(), and get_value_node().

Referenced by _process_value_desc(), studio::CellRenderer_TimeTrack::activate_vfunc(), studio::Duckmatic::add_to_ducks(), synfigapp::CanvasInterface::generate_param_list(), get_time_offset_from_vdesc(), get_times_from_vdesc(), studio::CanvasTreeStore::get_value_vfunc(), synfigapp::Action::ValueDescExport::is_candidate(), synfigapp::Action::ValueDescConnect::is_candidate(), synfigapp::Action::GradientSet::is_ready(), studio::Instance::make_param_menu(), synfigapp::Action::ValueDescExport::prepare(), synfigapp::Action::ValueDescBLineLink::prepare(), synfigapp::Action::GradientSet::set_param(), and synfigapp::Action::ColorSet::set_param().

bool synfigapp::ValueDesc::is_exported | ( |  | ) | const`[inline]`

References get_value_node(), and is_value_node().

Referenced by get_description(), and synfigapp::Action::ValueDescLink::prepare().

String ValueDesc::get_description | ( | bool | show_exported_name = `true` | ) | const

References _, get_index(), get_layer(), get_param_name(), get_parent_value_node(), get_value_node(), is_exported(), parent_is_canvas(), parent_is_layer_param(), parent_is_linkable_value_node(), parent_is_value_node(), parent_is_value_node_const(), and parent_is_waypoint().

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

- value_desc.h
- value_desc.cpp