Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
Inkscape::LivePathEffect::EnumEffectDataConverter< E > Class Template Reference

Simplified management of enumerations of LPE items with UI labels. More...

#include <effect-enum.h>

Public Types

typedef EnumEffectData< E > Data
 

Public Member Functions

 EnumEffectDataConverter (const EnumEffectData< E > *cd, const unsigned int length)
 
E get_id_from_label (const Glib::ustring &label) const
 
E get_id_from_key (const Glib::ustring &key) const
 
bool is_valid_key (const Glib::ustring &key) const
 
bool is_valid_id (const E id) const
 
const Glib::ustring & get_label (const E id) const
 
const Glib::ustring & get_key (const E id) const
 
const Glib::ustring & get_icon (const E id) const
 
const Glib::ustring & get_description (const E id) const
 
LPECategory get_category (const E id) const
 
bool get_on_path (const E id) const
 
bool get_on_shape (const E id) const
 
bool get_on_group (const E id) const
 
bool get_on_image (const E id) const
 
bool get_on_text (const E id) const
 
bool get_experimental (const E id) const
 
const EnumEffectData< E > & data (const unsigned int i) const
 

Public Attributes

const unsigned int _length
 

Private Attributes

const EnumEffectData< E > * _data
 

Detailed Description

template<typename E>
class Inkscape::LivePathEffect::EnumEffectDataConverter< E >

Simplified management of enumerations of LPE items with UI labels.

Note
that get_id_from_key and get_id_from_label return 0 if it cannot find an entry for that key string.
that get_label and get_key return an empty string when the requested id is not in the list.

Definition at line 142 of file effect-enum.h.

Member Typedef Documentation

◆ Data

template<typename E >
typedef EnumEffectData<E> Inkscape::LivePathEffect::EnumEffectDataConverter< E >::Data

Definition at line 144 of file effect-enum.h.

Constructor & Destructor Documentation

◆ EnumEffectDataConverter()

template<typename E >
Inkscape::LivePathEffect::EnumEffectDataConverter< E >::EnumEffectDataConverter ( const EnumEffectData< E > *  cd,
const unsigned int  length 
)
inline

Definition at line 146 of file effect-enum.h.

Member Function Documentation

◆ data()

template<typename E >
const EnumEffectData< E > & Inkscape::LivePathEffect::EnumEffectDataConverter< E >::data ( const unsigned int  i) const
inline

Definition at line 301 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data.

◆ get_category()

template<typename E >
LPECategory Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_category ( const E  id) const
inline

Definition at line 231 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and Inkscape::LivePathEffect::Undefined.

◆ get_description()

template<typename E >
const Glib::ustring & Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_description ( const E  id) const
inline

Definition at line 221 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and Inkscape::LivePathEffect::empty_string().

◆ get_experimental()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_experimental ( const E  id) const
inline

Definition at line 291 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

◆ get_icon()

template<typename E >
const Glib::ustring & Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_icon ( const E  id) const
inline

Definition at line 211 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and Inkscape::LivePathEffect::empty_string().

◆ get_id_from_key()

template<typename E >
E Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_key ( const Glib::ustring &  key) const
inline

Definition at line 162 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and key.

◆ get_id_from_label()

template<typename E >
E Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_label ( const Glib::ustring &  label) const
inline

Definition at line 152 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and label.

◆ get_key()

template<typename E >
const Glib::ustring & Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_key ( const E  id) const
inline

Definition at line 201 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and Inkscape::LivePathEffect::empty_string().

◆ get_label()

template<typename E >
const Glib::ustring & Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_label ( const E  id) const
inline

Definition at line 191 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and Inkscape::LivePathEffect::empty_string().

◆ get_on_group()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_group ( const E  id) const
inline

Definition at line 261 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

Referenced by Inkscape::UI::Dialog::LivePathEffectEditor::can_apply().

◆ get_on_image()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_image ( const E  id) const
inline

Definition at line 271 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

◆ get_on_path()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_path ( const E  id) const
inline

Definition at line 241 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

Referenced by Inkscape::UI::Dialog::LivePathEffectEditor::can_apply().

◆ get_on_shape()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_shape ( const E  id) const
inline

Definition at line 251 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

Referenced by Inkscape::UI::Dialog::LivePathEffectEditor::can_apply().

◆ get_on_text()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_text ( const E  id) const
inline

Definition at line 281 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

◆ is_valid_id()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_id ( const E  id) const
inline

Definition at line 182 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length.

◆ is_valid_key()

template<typename E >
bool Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_key ( const Glib::ustring &  key) const
inline

Definition at line 172 of file effect-enum.h.

References Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data, Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length, and key.

Member Data Documentation

◆ _data

template<typename E >
const EnumEffectData<E>* Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_data
private

Definition at line 306 of file effect-enum.h.

Referenced by Inkscape::LivePathEffect::EnumEffectDataConverter< E >::data(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_category(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_description(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_experimental(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_icon(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_key(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_label(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_key(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_label(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_group(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_image(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_path(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_shape(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_text(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_id(), and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_key().

◆ _length

template<typename E >
const unsigned int Inkscape::LivePathEffect::EnumEffectDataConverter< E >::_length

Definition at line 303 of file effect-enum.h.

Referenced by Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_category(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_description(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_experimental(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_icon(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_key(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_id_from_label(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_key(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_label(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_group(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_image(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_path(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_shape(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::get_on_text(), Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_id(), and Inkscape::LivePathEffect::EnumEffectDataConverter< E >::is_valid_key().

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