libglom-1.30: Glom::LayoutItem Class Reference

libglom-1.30 1.30.3

- Main Page
- Namespaces
- Classes

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

Public Member Functions | List of all members
Glom::LayoutItem Class Referenceabstract
Inheritance diagram for Glom::LayoutItem:
[legend]
Collaboration diagram for Glom::LayoutItem:
[legend]

## Public Member Functions
| LayoutItem ()
| LayoutItem (const LayoutItem& src)
| LayoutItem (LayoutItem&& src)=delete
LayoutItem& | operator= (const LayoutItem& src)
LayoutItem& | operator= (LayoutItem&& src)=delete
virtual | ~LayoutItem ()
virtual LayoutItem* | clone () const =0
| Create a new copied instance. More...
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
virtual Glib::ustring | get_part_type_name () const =0
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...
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

## 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

## Constructor & Destructor Documentation

Glom::LayoutItem::LayoutItem | ( |  | ) |

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

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

virtual Glom::LayoutItem::~LayoutItem | ( |  | ) |
| virtual

## Member Function Documentation

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

Create a new copied instance.

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

Implemented in Glom::LayoutItem_Field, Glom::LayoutItem_Portal, Glom::LayoutItem_GroupBy, Glom::LayoutItem_Image, Glom::LayoutItem_Placeholder, Glom::LayoutItem_Text, Glom::LayoutItem_Notebook, Glom::LayoutItem_Footer, Glom::LayoutItem_Header, Glom::LayoutItem_VerticalGroup, Glom::LayoutGroup, Glom::LayoutItem_Line, Glom::LayoutItem_Summary, Glom::LayoutItem_Button, Glom::LayoutItem_CalendarPortal, and Glom::LayoutItem_FieldSummary.

guint Glom::LayoutItem::get_display_width | ( |  | ) | const

virtual bool Glom::LayoutItem::get_editable | ( |  | ) | const
| virtual

virtual Glib::ustring Glom::LayoutItem::get_layout_display_name | ( |  | ) | const
| virtual

Reimplemented in Glom::LayoutItem_Field, Glom::LayoutItem_FieldSummary, and Glom::LayoutItem_GroupBy.

virtual Glib::ustring Glom::LayoutItem::get_part_type_name | ( |  | ) | const
| pure virtual

Implemented in Glom::LayoutGroup, Glom::LayoutItem_Field, Glom::LayoutItem_GroupBy, Glom::LayoutItem_Image, Glom::LayoutItem_Text, Glom::LayoutItem_Placeholder, Glom::LayoutItem_Notebook, Glom::LayoutItem_Line, Glom::LayoutItem_Footer, Glom::LayoutItem_Header, Glom::LayoutItem_VerticalGroup, Glom::LayoutItem_Button, Glom::LayoutItem_FieldSummary, Glom::LayoutItem_Summary, and Glom::LayoutItem_CalendarPortal.

void Glom::LayoutItem::get_print_layout_position | ( | double & | x,
|  | double & | y,
|  | double & | width,
|  | double & | height
| ) |  | const

This is used only for the print layouts.

bool Glom::LayoutItem::get_print_layout_split_across_pages | ( |  | ) | const

This is used only for the print layouts.

virtual Glib::ustring Glom::LayoutItem::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 in Glom::LayoutGroup, Glom::LayoutItem_Field, Glom::LayoutItem_GroupBy, Glom::LayoutItem_Image, Glom::LayoutItem_Text, Glom::LayoutItem_Placeholder, Glom::LayoutItem_Line, Glom::LayoutItem_Footer, Glom::LayoutItem_Header, Glom::LayoutItem_VerticalGroup, Glom::LayoutItem_FieldSummary, and Glom::LayoutItem_Summary.

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

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

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

void Glom::LayoutItem::set_display_width | ( | guint | value | ) |

virtual void Glom::LayoutItem::set_editable | ( | bool | val = `true` | ) |
| virtual

void Glom::LayoutItem::set_print_layout_position | ( | double | x,
|  | double | y,
|  | double | width,
|  | double | height
| ) |  |

This is used only for the print layouts.

void Glom::LayoutItem::set_print_layout_position_y | ( | double | y | ) |

This is used only for the print layouts.

void Glom::LayoutItem::set_print_layout_split_across_pages | ( | bool | split = `true` | ) |

This is used only for the print layouts.

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

- libglom/data_structure/layout/layoutitem.h