Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Inkscape::LivePathEffect::ToggleButtonParam Class Reference

class ToggleButtonParam: represents a Gtk::ToggleButton as a Live Path Effect parameter More...

#include <togglebutton.h>

Inheritance diagram for Inkscape::LivePathEffect::ToggleButtonParam:
Inkscape::LivePathEffect::Parameter

Public Member Functions

 ToggleButtonParam (const Glib::ustring &label, const Glib::ustring &tip, const Glib::ustring &key, Inkscape::UI::Widget::Registry *wr, Effect *effect, bool default_value=false, Glib::ustring inactive_label="", char const *icon_active=nullptr, char const *icon_inactive=nullptr, Gtk::IconSize icon_size=Gtk::IconSize::NORMAL)
 
 ~ToggleButtonParam () override
 
 ToggleButtonParam (const ToggleButtonParam &)=delete
 
ToggleButtonParam & operator= (const ToggleButtonParam &)=delete
 
Gtk::Widget * param_newWidget () override
 
bool param_readSVGValue (const gchar *strvalue) override
 
Glib::ustring param_getSVGValue () const override
 
Glib::ustring param_getDefaultSVGValue () const override
 
void param_setValue (bool newvalue)
 
void param_set_default () override
 
bool get_value () const
 
 operator bool () const
 
sigc::signal< void()> & signal_toggled ()
 
virtual void toggled ()
 
void param_update_default (bool default_value)
 
void param_update_default (const gchar *default_value) override
 
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 addCanvasIndicators (SPLPEItem const *, std::vector< Geom::PathVector > &)
 
virtual void param_editOncanvas (SPItem *, SPDesktop *)
 
virtual void param_setup_nodepath (Inkscape::NodePath::Path *)
 
virtual void param_transform_multiply (Geom::Affine const &, bool set)
 
virtual std::vector< SPObject * > param_get_satellites ()
 
void param_higlight (bool highlight)
 
void change_selection (Inkscape::Selection *selection)
 
void update_satellites ()
 
EffectType effectType () const
 
void connect_selection_changed ()
 

Private Member Functions

void refresh_button ()
 

Private Attributes

bool value
 
bool defvalue
 
const Glib::ustring inactive_label
 
const char * _icon_active
 
const char * _icon_inactive
 
Gtk::IconSize _icon_size
 
Inkscape::UI::Widget::RegisteredToggleButton * checkwdg
 
sigc::signal< void()> _signal_toggled
 
sigc::connection _toggled_connection
 

Additional Inherited Members

- 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 inherited from Inkscape::LivePathEffect::Parameter
void param_write_to_repr (const char *svgd)
 
- Protected Attributes inherited from Inkscape::LivePathEffect::Parameter
bool _updating = false
 
Inkscape::Display::TemporaryItem * ownerlocator = nullptr
 
Effect * param_effect
 

Detailed Description

class ToggleButtonParam: represents a Gtk::ToggleButton as a Live Path Effect parameter

Definition at line 26 of file togglebutton.h.

Constructor & Destructor Documentation

◆ ToggleButtonParam() [1/2]

Inkscape::LivePathEffect::ToggleButtonParam::ToggleButtonParam ( const Glib::ustring &  label,
const Glib::ustring &  tip,
const Glib::ustring &  key,
Inkscape::UI::Widget::Registry *  wr,
Effect *  effect,
bool  default_value = false,
Glib::ustring  inactive_label = "",
char const *  icon_active = nullptr,
char const *  icon_inactive = nullptr,
Gtk::IconSize  icon_size = Gtk::IconSize::NORMAL 
)

Definition at line 29 of file togglebutton.cpp.

References checkwdg.

◆ ~ToggleButtonParam()

Inkscape::LivePathEffect::ToggleButtonParam::~ToggleButtonParam ( )
override

Definition at line 44 of file togglebutton.cpp.

References _toggled_connection.

◆ ToggleButtonParam() [2/2]

Inkscape::LivePathEffect::ToggleButtonParam::ToggleButtonParam ( const ToggleButtonParam &  )
delete

Member Function Documentation

◆ get_value()

bool Inkscape::LivePathEffect::ToggleButtonParam::get_value ( ) const
inline

Definition at line 45 of file togglebutton.h.

References value.

◆ operator bool()

Inkscape::LivePathEffect::ToggleButtonParam::operator bool ( ) const
inline

Definition at line 47 of file togglebutton.h.

References value.

◆ operator=()

ToggleButtonParam & Inkscape::LivePathEffect::ToggleButtonParam::operator= ( const ToggleButtonParam &  )
delete

◆ param_getDefaultSVGValue()

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

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 70 of file togglebutton.cpp.

References defvalue.

◆ param_getSVGValue()

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

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 64 of file togglebutton.cpp.

References value.

◆ param_newWidget()

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

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 88 of file togglebutton.cpp.

References _icon_active, _icon_inactive, _icon_size, _toggled_connection, checkwdg, Inkscape::LivePathEffect::Effect::getRepr(), Inkscape::LivePathEffect::Effect::getSPDoc(), inactive_label, label, Inkscape::UI::pack_start(), Inkscape::LivePathEffect::Parameter::param_effect, Inkscape::LivePathEffect::Parameter::param_key, Inkscape::LivePathEffect::Parameter::param_label, Inkscape::LivePathEffect::Parameter::param_tooltip, Inkscape::LivePathEffect::Parameter::param_wr, Inkscape::UI::Widget::RegisteredWidget< W >::set_undo_parameters(), Inkscape::UI::Widget::RegisteredToggleButton::setActive(), Inkscape::UI::Widget::RegisteredToggleButton::setProgrammatically, sp_get_icon_image(), toggled(), and value.

◆ param_readSVGValue()

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

Definition at line 57 of file togglebutton.cpp.

References defvalue, param_setValue(), and Inkscape::Util::read_bool().

◆ param_set_default()

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

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 51 of file togglebutton.cpp.

References defvalue, and param_setValue().

◆ param_setValue()

void Inkscape::LivePathEffect::ToggleButtonParam::param_setValue ( bool  newvalue)

Definition at line 182 of file togglebutton.cpp.

References Inkscape::LivePathEffect::Parameter::param_effect, refresh_button(), Inkscape::LivePathEffect::Effect::refresh_widgets, and value.

Referenced by param_readSVGValue(), and param_set_default().

◆ param_update_default() [1/2]

void Inkscape::LivePathEffect::ToggleButtonParam::param_update_default ( bool  default_value)

Definition at line 76 of file togglebutton.cpp.

References defvalue.

Referenced by param_update_default().

◆ param_update_default() [2/2]

void Inkscape::LivePathEffect::ToggleButtonParam::param_update_default ( const gchar *  default_value)
override

Definition at line 82 of file togglebutton.cpp.

References defvalue, param_update_default(), and Inkscape::Util::read_bool().

◆ paramType()

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

Implements Inkscape::LivePathEffect::Parameter.

Definition at line 53 of file togglebutton.h.

References Inkscape::LivePathEffect::TOGGLE_BUTTON.

◆ refresh_button()

void Inkscape::LivePathEffect::ToggleButtonParam::refresh_button ( )
private

Definition at line 143 of file togglebutton.cpp.

References _icon_active, _icon_inactive, _icon_size, _toggled_connection, checkwdg, Inkscape::UI::get_children(), inactive_label, Inkscape::LivePathEffect::Parameter::param_label, and value.

Referenced by param_setValue().

◆ signal_toggled()

sigc::signal< void()> & Inkscape::LivePathEffect::ToggleButtonParam::signal_toggled ( )
inline

Definition at line 49 of file togglebutton.h.

References _signal_toggled.

◆ toggled()

void Inkscape::LivePathEffect::ToggleButtonParam::toggled ( )
virtual

Definition at line 192 of file togglebutton.cpp.

References _signal_toggled, and Inkscape::Selection::emitModified().

Referenced by param_newWidget().

Member Data Documentation

◆ _icon_active

const char* Inkscape::LivePathEffect::ToggleButtonParam::_icon_active
private

Definition at line 59 of file togglebutton.h.

Referenced by param_newWidget(), and refresh_button().

◆ _icon_inactive

const char* Inkscape::LivePathEffect::ToggleButtonParam::_icon_inactive
private

Definition at line 60 of file togglebutton.h.

Referenced by param_newWidget(), and refresh_button().

◆ _icon_size

Gtk::IconSize Inkscape::LivePathEffect::ToggleButtonParam::_icon_size
private

Definition at line 61 of file togglebutton.h.

Referenced by param_newWidget(), and refresh_button().

◆ _signal_toggled

sigc::signal<void ()> Inkscape::LivePathEffect::ToggleButtonParam::_signal_toggled
private

Definition at line 64 of file togglebutton.h.

Referenced by signal_toggled(), and toggled().

◆ _toggled_connection

sigc::connection Inkscape::LivePathEffect::ToggleButtonParam::_toggled_connection
private

Definition at line 65 of file togglebutton.h.

Referenced by param_newWidget(), refresh_button(), and ~ToggleButtonParam().

◆ checkwdg

Inkscape::UI::Widget::RegisteredToggleButton* Inkscape::LivePathEffect::ToggleButtonParam::checkwdg
private

Definition at line 62 of file togglebutton.h.

Referenced by param_newWidget(), refresh_button(), and ToggleButtonParam().

◆ defvalue

bool Inkscape::LivePathEffect::ToggleButtonParam::defvalue
private

Definition at line 57 of file togglebutton.h.

Referenced by param_getDefaultSVGValue(), param_readSVGValue(), param_set_default(), param_update_default(), and param_update_default().

◆ inactive_label

const Glib::ustring Inkscape::LivePathEffect::ToggleButtonParam::inactive_label
private

Definition at line 58 of file togglebutton.h.

Referenced by param_newWidget(), and refresh_button().

◆ value

bool Inkscape::LivePathEffect::ToggleButtonParam::value
private

Definition at line 56 of file togglebutton.h.

Referenced by get_value(), operator bool(), param_getSVGValue(), param_newWidget(), param_setValue(), and refresh_button().

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