libglom-1.30  1.30.0
Public Member Functions | Public Attributes | List of all members
Glom::LayoutItem_WithFormatting Class Reference

A base class for all layout items that may have formatting options. More...

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

Public Member Functions

 LayoutItem_WithFormatting ()
 
 LayoutItem_WithFormatting (const LayoutItem_WithFormatting& src)
 
 LayoutItem_WithFormatting (LayoutItem_WithFormatting&& src)=delete
 
LayoutItem_WithFormattingoperator= (const LayoutItem_WithFormatting& src)
 
LayoutItem_WithFormattingoperator= (LayoutItem_WithFormatting&& src)=delete
 
virtual ~LayoutItem_WithFormatting ()
 
bool operator== (const LayoutItem_WithFormatting& src) const
 
virtual const Formattingget_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
 
LayoutItemoperator= (const LayoutItem& src)
 
LayoutItemoperator= (LayoutItem&& src)=delete
 
virtual ~LayoutItem ()
 
virtual LayoutItemclone () 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 ()
 
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...
 
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

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::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 base class for all layout items that may have formatting options.

See get_formatting_used().

Constructor & Destructor Documentation

Glom::LayoutItem_WithFormatting::LayoutItem_WithFormatting ( )
Glom::LayoutItem_WithFormatting::LayoutItem_WithFormatting ( const LayoutItem_WithFormatting src)
Glom::LayoutItem_WithFormatting::LayoutItem_WithFormatting ( LayoutItem_WithFormatting&&  src)
delete
virtual Glom::LayoutItem_WithFormatting::~LayoutItem_WithFormatting ( )
virtual

Member Function Documentation

virtual const Formatting& Glom::LayoutItem_WithFormatting::get_formatting_used ( ) const
virtual

Get the field formatting used by this layout item, which may be either custom field formatting or the default field formatting.

Reimplemented in Glom::LayoutItem_Field.

virtual Formatting::HorizontalAlignment Glom::LayoutItem_WithFormatting::get_formatting_used_horizontal_alignment ( bool  for_details_view = false) const
virtual

Get the alignment for the formatting used (see get_formatting_used()), choosing an appropriate alignment if it is set to HorizontalAlignment::AUTO.

Note that this never returns HorizontalAlignment::AUTO.

Reimplemented in Glom::LayoutItem_Field.

LayoutItem_WithFormatting& Glom::LayoutItem_WithFormatting::operator= ( const LayoutItem_WithFormatting src)
LayoutItem_WithFormatting& Glom::LayoutItem_WithFormatting::operator= ( LayoutItem_WithFormatting&&  src)
delete
bool Glom::LayoutItem_WithFormatting::operator== ( const LayoutItem_WithFormatting src) const

Member Data Documentation

Formatting Glom::LayoutItem_WithFormatting::m_formatting

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