libglom-1.30: Glom::LayoutItem_Text Class Reference

libglom-1.30 1.30.3

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Public Attributes | List of all members
Glom::LayoutItem_Text Class Reference

A layout item for static text, and an optional title. More...

Inheritance diagram for Glom::LayoutItem_Text:
[legend]
Collaboration diagram for Glom::LayoutItem_Text:
[legend]

## Public Member Functions
| LayoutItem_Text ()
| LayoutItem_Text (const LayoutItem_Text& src)
| LayoutItem_Text (LayoutItem_Text&& src)=delete
LayoutItem_Text& | operator= (const LayoutItem_Text& src)
LayoutItem_Text& | operator= (LayoutItem_Text&& src)=delete
virtual | ~LayoutItem_Text ()
virtual LayoutItem* | clone () const
| Create a new copied instance. More...
bool | operator== (const LayoutItem_Text& src) const
virtual Glib::ustring | get_part_type_name () const
virtual Glib::ustring | get_report_part_id () const
| Gets the node name to use for the intermediate XML, (and usually, the CSS style class to use for the resulting HTML). More...
Glib::ustring | get_text (const Glib::ustring& locale) const
| Get the text that will be shown on each record. More...
void | set_text (const Glib::ustring& text, const Glib::ustring& locale)
| Set the text that will be shown on each record. More...
void | set_text_original (const Glib::ustring& text)
| Set the text's original (non-translated, usually English) text. More...
Public Member Functions inherited from Glom::LayoutItem_WithFormatting
| LayoutItem_WithFormatting ()
| LayoutItem_WithFormatting (const LayoutItem_WithFormatting& src)
| LayoutItem_WithFormatting (LayoutItem_WithFormatting&& src)=delete
LayoutItem_WithFormatting& | operator= (const LayoutItem_WithFormatting& src)
LayoutItem_WithFormatting& | operator= (LayoutItem_WithFormatting&& src)=delete
virtual | ~LayoutItem_WithFormatting ()
bool | operator== (const LayoutItem_WithFormatting& src) const
virtual const Formatting& | get_formatting_used () const
| Get the field formatting used by this layout item, which may be either custom field formatting or the default field formatting. More...
virtual Formatting::HorizontalAlignment | get_formatting_used_horizontal_alignment (bool for_details_view=false) const
| Get the alignment for the formatting used (see get_formatting_used()), choosing an appropriate alignment if it is set to HorizontalAlignment::AUTO. More...
Public Member Functions inherited from Glom::LayoutItem
| LayoutItem ()
| LayoutItem (const LayoutItem& src)
| LayoutItem (LayoutItem&& src)=delete
LayoutItem& | operator= (const LayoutItem& src)
LayoutItem& | operator= (LayoutItem&& src)=delete
virtual | ~LayoutItem ()
bool | operator== (const LayoutItem& src) const
virtual bool | get_editable () const
virtual void | set_editable (bool val=true)
virtual Glib::ustring | get_layout_display_name () const
guint | get_display_width () const
void | set_display_width (guint value)
void | get_print_layout_position (double& x, double& y, double& width, double& height) const
| This is used only for the print layouts. More...
void | set_print_layout_position (double x, double y, double width, double height)
| This is used only for the print layouts. More...
void | set_print_layout_position_y (double y)
| This is used only for the print layouts. More...
void | set_print_layout_split_across_pages (bool split=true)
| This is used only for the print layouts. More...
bool | get_print_layout_split_across_pages () const
| This is used only for the print layouts. More...
Public Member Functions inherited from Glom::TranslatableItem
| TranslatableItem () noexcept
| TranslatableItem (const TranslatableItem& src) noexcept
| TranslatableItem (TranslatableItem&& src) noexcept
virtual | ~TranslatableItem ()
TranslatableItem& | operator= (const TranslatableItem& src) noexcept
TranslatableItem& | operator= (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...
virtual Glib::ustring | get_title_original () const noexcept
| Get the title's original (non-translated, usually English) text. 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

## Public Attributes
std::shared_ptr< StaticText > | m_text
Public Attributes inherited from Glom::LayoutItem_WithFormatting
Formatting | m_formatting

## 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::ustring > | type_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 layout item for static text, and an optional title.

The base class TranslatableItem holds the title, and the actual (translatable) text is in the m_text member.

## Constructor & Destructor Documentation

Glom::LayoutItem_Text::LayoutItem_Text | ( |  | ) |

Glom::LayoutItem_Text::LayoutItem_Text | ( | const LayoutItem_Text& | src | ) |

Glom::LayoutItem_Text::LayoutItem_Text | ( | LayoutItem_Text&& | src | ) |
| delete

virtual Glom::LayoutItem_Text::~LayoutItem_Text | ( |  | ) |
| virtual

## Member Function Documentation

virtual LayoutItem* Glom::LayoutItem_Text::clone | ( |  | ) | const
| virtual

Create a new copied instance.

This allows us to deep-copy a list of LayoutItems.

Implements Glom::LayoutItem.

virtual Glib::ustring Glom::LayoutItem_Text::get_part_type_name | ( |  | ) | const
| virtual

Implements Glom::LayoutItem.

virtual Glib::ustring Glom::LayoutItem_Text::get_report_part_id | ( |  | ) | const
| virtual

Gets the node name to use for the intermediate XML, (and usually, the CSS style class to use for the resulting HTML).

Reimplemented from Glom::LayoutItem.

Glib::ustring Glom::LayoutItem_Text::get_text | ( | const Glib::ustring & | locale | ) | const

Get the text that will be shown on each record.

LayoutItem_Text& Glom::LayoutItem_Text::operator= | ( | const LayoutItem_Text& | src | ) |

LayoutItem_Text& Glom::LayoutItem_Text::operator= | ( | LayoutItem_Text&& | src | ) |
| delete

bool Glom::LayoutItem_Text::operator== | ( | const LayoutItem_Text& | src | ) | const

void Glom::LayoutItem_Text::set_text | ( | const Glib::ustring & | text,
|  | const Glib::ustring & | locale
| ) |  |

Set the text that will be shown on each record.

void Glom::LayoutItem_Text::set_text_original | ( | const Glib::ustring & | text | ) |

Set the text's original (non-translated, usually English) text.

This is the same as calling set_text() with an empty locale parameter.

## Member Data Documentation

std::shared_ptr<StaticText> Glom::LayoutItem_Text::m_text

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

- libglom/data_structure/layout/layoutitem_text.h