libglom-1.30  1.30.4
Public Member Functions | List of all members
Glom::ChoiceValue Class Reference

A value of a custom choice, for a field or a layout item. More...

Inheritance diagram for Glom::ChoiceValue:
Inheritance graph
[legend]
Collaboration diagram for Glom::ChoiceValue:
Collaboration graph
[legend]

Public Member Functions

 ChoiceValue ()
 
 ChoiceValue (const ChoiceValue& src)
 
 ChoiceValue (ChoiceValue&& src)=delete
 
 ~ChoiceValue ()
 
ChoiceValueoperator= (const ChoiceValue& src)
 
ChoiceValueoperator= (ChoiceValue&& src)=delete
 
bool operator== (const ChoiceValue& src) const
 
bool operator!= (const ChoiceValue& src) const
 
ChoiceValueclone () const
 
void set_value (const Gnome::Gda::Value& value)
 
Gnome::Gda::Value get_value () const
 
virtual Glib::ustring get_title_original () const noexceptoverride
 This override makes sure that we can generically use ChoiceValue like any other TranslatableItem, assuming that the value is a title, if it is a text value. More...
 
bool is_translatable () const
 Whether the value is of a type that can be translated. More...
 
- Public Member Functions inherited from Glom::TranslatableItem
 TranslatableItem () noexcept
 
 TranslatableItem (const TranslatableItem& src) noexcept
 
 TranslatableItem (TranslatableItem&& src) noexcept
 
virtual ~TranslatableItem ()
 
TranslatableItemoperator= (const TranslatableItem& src) noexcept
 
TranslatableItemoperator= (TranslatableItem&& src) noexcept
 
bool operator== (const TranslatableItem& src) const noexcept
 
bool operator!= (const TranslatableItem& src) const noexcept
 
virtual void set_name (const Glib::ustring& name) noexcept
 Set the non-translated identifier name. More...
 
virtual Glib::ustring get_name () const noexcept
 Get the non-translated identifier name. More...
 
bool get_name_not_empty () const noexcept
 
virtual Glib::ustring get_title_or_name (const Glib::ustring& locale) const noexcept
 
virtual Glib::ustring get_title (const Glib::ustring& locale) const noexcept
 Get the title's translation for the specified locale, falling back to the original text if there is no translation. More...
 
Glib::ustring get_title_translation (const Glib::ustring& locale, bool fallback=true) const noexcept
 Get the title's translation for the specified locale, optionally falling back to a locale of the same language, and then falling back to the original. More...
 
void set_title (const Glib::ustring& title, const Glib::ustring& locale) noexcept
 Set the title's translation for the specified locale. More...
 
void set_title_original (const Glib::ustring& title) noexcept
 Set the title's original (non-translated, usually English) text. More...
 
void clear_title_in_all_locales () noexcept
 Clear the original title and any translations of the title. More...
 
bool get_has_translations () const noexcept
 
enumTranslatableItemType get_translatable_item_type () const noexcept
 

Additional Inherited Members

- Public Types inherited from Glom::TranslatableItem
enum  enumTranslatableItemType {
  enumTranslatableItemType::INVALID,
  enumTranslatableItemType::FIELD,
  enumTranslatableItemType::RELATIONSHIP,
  enumTranslatableItemType::LAYOUT_ITEM,
  enumTranslatableItemType::CUSTOM_TITLE,
  enumTranslatableItemType::PRINT_LAYOUT,
  enumTranslatableItemType::REPORT,
  enumTranslatableItemType::TABLE,
  enumTranslatableItemType::BUTTON,
  enumTranslatableItemType::TEXTOBJECT,
  enumTranslatableItemType::IMAGEOBJECT,
  enumTranslatableItemType::CHOICEVALUE,
  enumTranslatableItemType::DATABASE_TITLE,
  enumTranslatableItemType::STATIC_TEXT
}
 
typedef std::map< Glib::ustring, Glib::ustringtype_map_locale_to_translations
 
- Static Public Member Functions inherited from Glom::TranslatableItem
static Glib::ustring get_translatable_type_name (enumTranslatableItemType item_type) noexcept
 
static Glib::ustring get_translatable_type_name_nontranslated (enumTranslatableItemType item_type) noexcept
 The non-translated name is used for the context in gettext .po files. More...
 
- Protected Attributes inherited from Glom::TranslatableItem
enumTranslatableItemType m_translatable_item_type
 

Detailed Description

A value of a custom choice, for a field or a layout item.

This is translatable, but that only make sense for text fields.

Text-specific methods such as get/set_title() should be ignored.

Constructor & Destructor Documentation

Glom::ChoiceValue::ChoiceValue ( )
Glom::ChoiceValue::ChoiceValue ( const ChoiceValue src)
Glom::ChoiceValue::ChoiceValue ( ChoiceValue&&  src)
delete
Glom::ChoiceValue::~ChoiceValue ( )

Member Function Documentation

ChoiceValue* Glom::ChoiceValue::clone ( ) const
virtual Glib::ustring Glom::ChoiceValue::get_title_original ( ) const
overridevirtualnoexcept

This override makes sure that we can generically use ChoiceValue like any other TranslatableItem, assuming that the value is a title, if it is a text value.

Reimplemented from Glom::TranslatableItem.

Gnome::Gda::Value Glom::ChoiceValue::get_value ( ) const
bool Glom::ChoiceValue::is_translatable ( ) const

Whether the value is of a type that can be translated.

This means that it must be a text type.

bool Glom::ChoiceValue::operator!= ( const ChoiceValue src) const
ChoiceValue& Glom::ChoiceValue::operator= ( const ChoiceValue src)
ChoiceValue& Glom::ChoiceValue::operator= ( ChoiceValue&&  src)
delete
bool Glom::ChoiceValue::operator== ( const ChoiceValue src) const
void Glom::ChoiceValue::set_value ( const Gnome::Gda::Value &  value)

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