Inkscape::Util::EnumDataConverter< E > Class Template Reference

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

#include <enums.h>

Public Types
typedef EnumData< E >	Data

Public Member Functions
	EnumDataConverter (const EnumData< 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 EnumData< E > &	data (const unsigned int i) const

Public Attributes
const unsigned int	_length

Private Attributes
const EnumData< E > *	_data

Detailed Description

template<typename E>
class Inkscape::Util::EnumDataConverter< E >

Simplified management of enumerations of svg 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 41 of file enums.h.

Member Typedef Documentation

Data

template<typename E >

typedef EnumData<E> Inkscape::Util::EnumDataConverter< E >::Data

Definition at line 44 of file enums.h.

Constructor & Destructor Documentation

EnumDataConverter()

template<typename E >

Inkscape::Util::EnumDataConverter< E >::EnumDataConverter ( const EnumData< E > *  cd, const unsigned int  length  )

inline

Definition at line 46 of file enums.h.

Member Function Documentation

data()

template<typename E >

const EnumData< E > & Inkscape::Util::EnumDataConverter< E >::data ( const unsigned int  i ) const

inline

Definition at line 109 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data.

Referenced by Inkscape::UI::Dialog::ObjectsPanel::ObjectsPanel().

get_id_from_key()

template<typename E >

E Inkscape::Util::EnumDataConverter< E >::get_id_from_key ( const Glib::ustring &  key ) const

inline

Definition at line 60 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, Inkscape::Util::EnumDataConverter< E >::_length, and key.

Referenced by Inkscape::LivePathEffect::LPETaperStroke::doBeforeEffect(), Inkscape::UI::Dialog::FilterEffectsDialog::PrimitiveList::update(), and Inkscape::UI::Dialog::FilterEffectsDialog::update_settings_view().

get_id_from_label()

template<typename E >

E Inkscape::Util::EnumDataConverter< E >::get_id_from_label ( const Glib::ustring &  label ) const

inline

Definition at line 50 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, Inkscape::Util::EnumDataConverter< E >::_length, and label.

get_key()

template<typename E >

const Glib::ustring & Inkscape::Util::EnumDataConverter< E >::get_key ( const E  id ) const

inline

Definition at line 99 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, Inkscape::Util::EnumDataConverter< E >::_length, and Inkscape::Util::empty_string().

Referenced by filter_add_primitive().

get_label()

template<typename E >

const Glib::ustring & Inkscape::Util::EnumDataConverter< E >::get_label ( const E  id ) const

inline

Definition at line 89 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, Inkscape::Util::EnumDataConverter< E >::_length, and Inkscape::Util::empty_string().

Referenced by Inkscape::UI::Dialog::FilterEffectsDialog::add_effects(), Inkscape::UI::Dialog::FilterEffectsDialog::PrimitiveList::update(), and Inkscape::UI::Dialog::FilterEffectsDialog::update_settings_view().

is_valid_id()

template<typename E >

bool Inkscape::Util::EnumDataConverter< E >::is_valid_id ( const E  id ) const

inline

Definition at line 80 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, and Inkscape::Util::EnumDataConverter< E >::_length.

is_valid_key()

template<typename E >

bool Inkscape::Util::EnumDataConverter< E >::is_valid_key ( const Glib::ustring &  key ) const

inline

Definition at line 70 of file enums.h.

References Inkscape::Util::EnumDataConverter< E >::_data, Inkscape::Util::EnumDataConverter< E >::_length, and key.

Member Data Documentation

_data

template<typename E >

const EnumData<E>* Inkscape::Util::EnumDataConverter< E >::_data

private

Definition at line 116 of file enums.h.

Referenced by Inkscape::Util::EnumDataConverter< E >::data(), Inkscape::Util::EnumDataConverter< E >::get_id_from_key(), Inkscape::Util::EnumDataConverter< E >::get_id_from_label(), Inkscape::Util::EnumDataConverter< E >::get_key(), Inkscape::Util::EnumDataConverter< E >::get_label(), Inkscape::Util::EnumDataConverter< E >::is_valid_id(), and Inkscape::Util::EnumDataConverter< E >::is_valid_key().

_length

template<typename E >

const unsigned int Inkscape::Util::EnumDataConverter< E >::_length

Definition at line 114 of file enums.h.

Referenced by Inkscape::Util::EnumDataConverter< E >::get_id_from_key(), Inkscape::Util::EnumDataConverter< E >::get_id_from_label(), Inkscape::Util::EnumDataConverter< E >::get_key(), Inkscape::Util::EnumDataConverter< E >::get_label(), Inkscape::Util::EnumDataConverter< E >::is_valid_id(), Inkscape::Util::EnumDataConverter< E >::is_valid_key(), and Inkscape::UI::Dialog::ObjectsPanel::ObjectsPanel().

---

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

• /builds/inkscape/inkscape/src/util/enums.h