Inkscape
Vector Graphics Editor
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages Concepts
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
Inkscape::LivePathEffect::SatelliteParam Class Reference

#include <satellite.h>

Inheritance diagram for Inkscape::LivePathEffect::SatelliteParam:
Inkscape::LivePathEffect::Parameter Inkscape::LivePathEffect::OriginalSatelliteParam

Public Member Functions

 SatelliteParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry *wr, Effect *effect)
 
 ~SatelliteParam () override
 
bool param_readSVGValue (const gchar *strvalue) override
 
Glib::ustring param_getSVGValue () const override
 
Glib::ustring param_getDefaultSVGValue () const override
 
void param_set_default () override
 
void param_update_default (const gchar *default_value) override
 
bool linksToItem () const
 
SPObject * getObject () const
 
Gtk::Widget * param_newWidget () override
 
void addCanvasIndicators (SPLPEItem const *lpeitem, std::vector< Geom::PathVector > &hp_vec) override
 
void on_link_button_click ()
 
bool isConnected ()
 
void start_listening (SPObject *to)
 
void unlink ()
 
ParamType paramType () const override
 
- Public Member Functions inherited from Inkscape::LivePathEffect::Parameter
 Parameter (Glib::ustring label, Glib::ustring tip, Glib::ustring key, Inkscape::UI::Widget::Registry *wr, Effect *effect)
 
virtual ~Parameter ()
 
 Parameter (const Parameter &)=delete
 
Parameter & operator= (const Parameter &)=delete
 
virtual bool param_readSVGValue (char const *strvalue)=0
 
virtual void param_widget_is_visible (bool is_visible)
 
virtual void param_widget_is_enabled (bool is_enabled)
 
void write_to_SVG ()
 
void read_from_SVG ()
 
void setUpdating (bool updating)
 
bool getUpdating () const
 
virtual void param_update_default (char const *default_value)=0
 
Glib::ustring const * param_getTooltip () const
 
virtual bool providesKnotHolderEntities () const
 
virtual void addKnotHolderEntities (KnotHolder *, SPItem *)
 
virtual void param_editOncanvas (SPItem *, SPDesktop *)
 
virtual void param_setup_nodepath (Inkscape::NodePath::Path *)
 
virtual void param_transform_multiply (Geom::Affine const &, bool set)
 
void param_higlight (bool highlight)
 
void change_selection (Inkscape::Selection *selection)
 
void update_satellites ()
 
EffectType effectType () const
 
void connect_selection_changed ()
 

Public Attributes

Geom::Affine last_transform
 
bool lookup = false
 
- Public Attributes inherited from Inkscape::LivePathEffect::Parameter
sigc::scoped_connection selection_changed_connection
 
Glib::ustring param_key
 
Glib::ustring param_tooltip
 
Inkscape::UI::Widget::Registry * param_wr
 
Glib::ustring param_label
 
bool oncanvas_editable
 
bool widget_is_visible
 
bool widget_is_enabled
 

Protected Member Functions

void link (Glib::ustring itemid)
 
void quit_listening ()
 
void linked_released (SPObject *released_item)
 
void linked_deleted (SPObject *deleted_item)
 
void linked_transformed (Geom::Affine const *rel_transf, SPItem *moved_item)
 
void linked_modified (SPObject *linked_obj, guint flags)
 
void linked_changed (SPObject *old_obj, SPObject *new_obj)
 
- Protected Member Functions inherited from Inkscape::LivePathEffect::Parameter
void param_write_to_repr (const char *svgd)
 

Protected Attributes

std::shared_ptr< SatelliteReference > lperef
 
- Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool _updating = false
 
Inkscape::Display::TemporaryItem * ownerlocator = nullptr
 
Effect * param_effect
 

Private Member Functions

std::vector< SPObject * > param_get_satellites () override
 
 SatelliteParam (const SatelliteParam &)=delete
 
SatelliteParam & operator= (const SatelliteParam &)=delete
 

Private Attributes

sigc::connection linked_released_connection
 
sigc::connection linked_modified_connection
 
sigc::connection linked_transformed_connection
 
sigc::connection linked_changed_connection
 

Friends

class LPEBool
 
class LPECloneOriginal
 
class Effect
 

Detailed Description

Definition at line 23 of file satellite.h.

Constructor & Destructor Documentation

◆ SatelliteParam() [1/2]

Inkscape::LivePathEffect::SatelliteParam::SatelliteParam ( const Glib::ustring &  label,
const Glib::ustring &  tip,
const Glib::ustring &  key,
Inkscape::UI::Widget::Registry *  wr,
Effect *  effect 
)

Definition at line 31 of file satellite.cpp.

◆ ~SatelliteParam()

Inkscape::LivePathEffect::SatelliteParam::~SatelliteParam ( )
override

Definition at line 38 of file satellite.cpp.

References quit_listening().

◆ SatelliteParam() [2/2]

Inkscape::LivePathEffect::SatelliteParam::SatelliteParam ( const SatelliteParam &  )
privatedelete

Member Function Documentation

◆ addCanvasIndicators()

void Inkscape::LivePathEffect::SatelliteParam::addCanvasIndicators ( SPLPEItem const *  lpeitem,
std::vector< Geom::PathVector > &  hp_vec 
)
overridevirtual

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 237 of file satellite.cpp.

◆ getObject()

SPObject * Inkscape::LivePathEffect::SatelliteParam::getObject ( ) const

Definition at line 113 of file satellite.cpp.

References lperef.

Referenced by Inkscape::LivePathEffect::LPEBool::add_filter(), Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPEBoundingBox::doBeforeEffect(), Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect(), Inkscape::LivePathEffect::LPEBool::doEffect(), Inkscape::LivePathEffect::LPEBoundingBox::doEffect(), Inkscape::LivePathEffect::LPEBool::doOnOpen(), Inkscape::LivePathEffect::LPEBoundingBox::doOnOpen(), Inkscape::LivePathEffect::LPECloneOriginal::doOnOpen(), Inkscape::LivePathEffect::LPEBool::doOnRemove(), Inkscape::LivePathEffect::LPEBool::doOnVisibilityToggled(), link(), and Inkscape::LivePathEffect::LPEBool::LPEBool().

◆ isConnected()

bool Inkscape::LivePathEffect::SatelliteParam::isConnected ( )
inline

Definition at line 44 of file satellite.h.

References linked_changed_connection.

Referenced by Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), and Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect().

◆ link()

void Inkscape::LivePathEffect::SatelliteParam::link ( Glib::ustring  itemid)
protected

Definition at line 144 of file satellite.cpp.

References getObject(), Inkscape::LivePathEffect::Effect::getSPDoc(), Inkscape::LivePathEffect::Effect::makeUndoDone(), Inkscape::LivePathEffect::Parameter::param_effect, and Inkscape::LivePathEffect::Parameter::param_write_to_repr().

Referenced by on_link_button_click().

◆ linked_changed()

void Inkscape::LivePathEffect::SatelliteParam::linked_changed ( SPObject *  old_obj,
SPObject *  new_obj 
)
protected

Definition at line 197 of file satellite.cpp.

References quit_listening(), and start_listening().

Referenced by param_readSVGValue(), and start_listening().

◆ linked_deleted()

void Inkscape::LivePathEffect::SatelliteParam::linked_deleted ( SPObject *  deleted_item)
protected

◆ linked_modified()

void Inkscape::LivePathEffect::SatelliteParam::linked_modified ( SPObject *  linked_obj,
guint  flags 
)
protected

Definition at line 214 of file satellite.cpp.

References Inkscape::LivePathEffect::Parameter::_updating, Inkscape::LivePathEffect::CLONE_ORIGINAL, Inkscape::LivePathEffect::Parameter::effectType(), Inkscape::LivePathEffect::Effect::getLPEObj(), Geom::identity(), Inkscape::LivePathEffect::Effect::is_load, Inkscape::LivePathEffect::Effect::isReady(), last_transform, Inkscape::LivePathEffect::Parameter::ownerlocator, Inkscape::LivePathEffect::Parameter::param_effect, SPObject::requestModified(), and Inkscape::LivePathEffect::Parameter::update_satellites().

Referenced by start_listening().

◆ linked_released()

void Inkscape::LivePathEffect::SatelliteParam::linked_released ( SPObject *  released_item)
protected

Definition at line 205 of file satellite.cpp.

References Inkscape::LivePathEffect::Effect::getLPEObj(), Inkscape::LivePathEffect::LPE_UPDATE, Inkscape::LivePathEffect::Parameter::param_effect, Inkscape::LivePathEffect::Effect::processObjects(), and unlink().

Referenced by start_listening().

◆ linked_transformed()

void Inkscape::LivePathEffect::SatelliteParam::linked_transformed ( Geom::Affine const *  rel_transf,
SPItem *  moved_item 
)
protected

Definition at line 228 of file satellite.cpp.

References Inkscape::LivePathEffect::Parameter::_updating, and Inkscape::LivePathEffect::Parameter::update_satellites().

Referenced by start_listening().

◆ linksToItem()

bool Inkscape::LivePathEffect::SatelliteParam::linksToItem ( ) const

Definition at line 108 of file satellite.cpp.

References lperef.

Referenced by Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect(), Inkscape::LivePathEffect::LPEBoundingBox::doEffect(), and unlink().

◆ on_link_button_click()

void Inkscape::LivePathEffect::SatelliteParam::on_link_button_click ( )

Definition at line 239 of file satellite.cpp.

References Inkscape::LivePathEffect::CLONE_ORIGINAL, Inkscape::LivePathEffect::Parameter::effectType(), Inkscape::UI::ClipboardManager::get(), Inkscape::UI::ClipboardManager::getElementsOfType(), Inkscape::UI::ClipboardManager::getFirstObjectID(), Inkscape::LivePathEffect::Effect::is_load, link(), lookup, and Inkscape::LivePathEffect::Parameter::param_effect.

Referenced by Inkscape::LivePathEffect::OriginalSatelliteParam::param_newWidget(), and param_newWidget().

◆ operator=()

SatelliteParam & Inkscape::LivePathEffect::SatelliteParam::operator= ( const SatelliteParam &  )
privatedelete

◆ param_get_satellites()

std::vector< SPObject * > Inkscape::LivePathEffect::SatelliteParam::param_get_satellites ( )
overrideprivatevirtual

Reimplemented from Inkscape::LivePathEffect::Parameter.

Definition at line 42 of file satellite.cpp.

References linked_transformed_connection, lperef, and Inkscape::LivePathEffect::Parameter::write_to_SVG().

◆ param_getDefaultSVGValue()

Glib::ustring Inkscape::LivePathEffect::SatelliteParam::param_getDefaultSVGValue ( ) const
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 126 of file satellite.cpp.

◆ param_getSVGValue()

Glib::ustring Inkscape::LivePathEffect::SatelliteParam::param_getSVGValue ( ) const
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 118 of file satellite.cpp.

References lperef.

Referenced by param_readSVGValue().

◆ param_newWidget()

Gtk::Widget * Inkscape::LivePathEffect::SatelliteParam::param_newWidget ( )
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 263 of file satellite.cpp.

References on_link_button_click(), Inkscape::UI::pack_start(), Inkscape::LivePathEffect::Parameter::param_label, Inkscape::LivePathEffect::Parameter::param_tooltip, and sp_get_icon_image().

◆ param_readSVGValue()

bool Inkscape::LivePathEffect::SatelliteParam::param_readSVGValue ( const gchar *  strvalue)
override

Definition at line 57 of file satellite.cpp.

References SPObject::_tmpsuccessor, SPObject::getAttribute(), Inkscape::LivePathEffect::Effect::getCurrrentLPEItems(), SPObject::getId(), Inkscape::LivePathEffect::Effect::getLPEObj(), SPDocument::getObjectByHref(), Inkscape::LivePathEffect::Effect::getSPDoc(), Inkscape::LivePathEffect::Effect::is_applied, SPDocument::isSeeking(), linked_changed(), lperef, Inkscape::LivePathEffect::Parameter::param_effect, param_getSVGValue(), Inkscape::LivePathEffect::Parameter::param_write_to_repr(), and unlink().

Referenced by param_set_default().

◆ param_set_default()

void Inkscape::LivePathEffect::SatelliteParam::param_set_default ( )
overridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 131 of file satellite.cpp.

References param_readSVGValue().

Referenced by Inkscape::LivePathEffect::LPEBool::doEffect().

◆ param_update_default()

void Inkscape::LivePathEffect::SatelliteParam::param_update_default ( const gchar *  default_value)
inlineoverride

Definition at line 33 of file satellite.h.

◆ paramType()

ParamType Inkscape::LivePathEffect::SatelliteParam::paramType ( ) const
inlineoverridevirtual

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 48 of file satellite.h.

References Inkscape::LivePathEffect::SATELLITE.

◆ quit_listening()

void Inkscape::LivePathEffect::SatelliteParam::quit_listening ( )
protected

Definition at line 181 of file satellite.cpp.

References linked_changed_connection, linked_modified_connection, linked_released_connection, and linked_transformed_connection.

Referenced by Inkscape::LivePathEffect::LPECloneOriginal::doOnRemove(), linked_changed(), start_listening(), unlink(), and ~SatelliteParam().

◆ start_listening()

void Inkscape::LivePathEffect::SatelliteParam::start_listening ( SPObject *  to)

Definition at line 162 of file satellite.cpp.

References SPObject::connectModified(), SPObject::connectRelease(), SPItem::connectTransformed(), Inkscape::LivePathEffect::Effect::is_load, item, linked_changed(), linked_changed_connection, linked_modified(), linked_modified_connection, linked_released(), linked_released_connection, linked_transformed(), linked_transformed_connection, lperef, Inkscape::LivePathEffect::Parameter::param_effect, and quit_listening().

Referenced by Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPEBoundingBox::doBeforeEffect(), Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect(), Inkscape::LivePathEffect::LPEBool::doOnOpen(), Inkscape::LivePathEffect::LPEBoundingBox::doOnOpen(), Inkscape::LivePathEffect::LPECloneOriginal::doOnOpen(), and linked_changed().

◆ unlink()

void Inkscape::LivePathEffect::SatelliteParam::unlink ( )

Definition at line 136 of file satellite.cpp.

References linksToItem(), lperef, and quit_listening().

Referenced by Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect(), Inkscape::LivePathEffect::Effect::doOnBeforeCommit(), Inkscape::LivePathEffect::LPECloneOriginal::doOnRemove(), linked_released(), and param_readSVGValue().

Friends And Related Symbol Documentation

◆ Effect

friend class Effect
friend

Definition at line 42 of file satellite.h.

◆ LPEBool

friend class LPEBool
friend

Definition at line 40 of file satellite.h.

◆ LPECloneOriginal

friend class LPECloneOriginal
friend

Definition at line 41 of file satellite.h.

Member Data Documentation

◆ last_transform

Geom::Affine Inkscape::LivePathEffect::SatelliteParam::last_transform

Definition at line 43 of file satellite.h.

Referenced by linked_modified().

◆ linked_changed_connection

sigc::connection Inkscape::LivePathEffect::SatelliteParam::linked_changed_connection
private

Definition at line 65 of file satellite.h.

Referenced by isConnected(), quit_listening(), and start_listening().

◆ linked_modified_connection

sigc::connection Inkscape::LivePathEffect::SatelliteParam::linked_modified_connection
private

Definition at line 63 of file satellite.h.

Referenced by quit_listening(), and start_listening().

◆ linked_released_connection

sigc::connection Inkscape::LivePathEffect::SatelliteParam::linked_released_connection
private

Definition at line 62 of file satellite.h.

Referenced by quit_listening(), and start_listening().

◆ linked_transformed_connection

sigc::connection Inkscape::LivePathEffect::SatelliteParam::linked_transformed_connection
private

Definition at line 64 of file satellite.h.

Referenced by param_get_satellites(), quit_listening(), and start_listening().

◆ lookup

bool Inkscape::LivePathEffect::SatelliteParam::lookup = false

Definition at line 47 of file satellite.h.

Referenced by Inkscape::LivePathEffect::LPEBoundingBox::LPEBoundingBox(), and on_link_button_click().

◆ lperef

std::shared_ptr<SatelliteReference> Inkscape::LivePathEffect::SatelliteParam::lperef
protected

Definition at line 58 of file satellite.h.

Referenced by Inkscape::LivePathEffect::LPEBool::doBeforeEffect(), Inkscape::LivePathEffect::LPECloneOriginal::doBeforeEffect(), Inkscape::LivePathEffect::Effect::doOnBeforeCommit(), Inkscape::LivePathEffect::LPECloneOriginal::doOnRemove(), Inkscape::LivePathEffect::LPECloneOriginal::getHolderRemove(), getObject(), linksToItem(), Inkscape::LivePathEffect::OriginalSatelliteParam::on_select_original_button_click(), param_get_satellites(), param_getSVGValue(), param_readSVGValue(), start_listening(), and unlink().

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