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

The child items are fields to be shown for each record in the group. More...

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

Public Types

typedef Formatting::type_pair_sort_field type_pair_sort_field
 
typedef Formatting::type_list_sort_fields type_list_sort_fields
 
- Public Types inherited from Glom::LayoutGroup
typedef std::vector< std::shared_ptr< LayoutItem > > type_list_items
 
typedef std::vector< std::shared_ptr< const LayoutItem > > type_list_const_items
 
- 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
 

Public Member Functions

 LayoutItem_GroupBy ()
 
 LayoutItem_GroupBy (const LayoutItem_GroupBy& src)
 
 LayoutItem_GroupBy (LayoutItem_GroupBy&& src)=delete
 
LayoutItem_GroupByoperator= (const LayoutItem_GroupBy& src)
 
LayoutItem_GroupByoperator= (LayoutItem_GroupBy&& src)=delete
 
virtual ~LayoutItem_GroupBy ()
 
virtual LayoutItemclone () const
 Create a new copied instance. More...
 
std::shared_ptr< LayoutItem_Fieldget_field_group_by ()
 
std::shared_ptr< const LayoutItem_Fieldget_field_group_by () const
 
bool get_has_field_group_by () const
 
void set_field_group_by (const std::shared_ptr< LayoutItem_Field >& field)
 
type_list_sort_fields get_fields_sort_by ()
 
type_list_sort_fields get_fields_sort_by () const
 
bool get_has_fields_sort_by () const
 
void set_fields_sort_by (const type_list_sort_fields& field)
 
virtual Glib::ustring get_layout_display_name () const
 Get a text representation for the a layout. More...
 
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...
 
std::shared_ptr< LayoutGroupget_secondary_fields ()
 
std::shared_ptr< const LayoutGroupget_secondary_fields () const
 
- Public Member Functions inherited from Glom::LayoutGroup
 LayoutGroup ()
 
 LayoutGroup (const LayoutGroup& src)
 
 LayoutGroup (LayoutGroup&& src)=delete
 
LayoutGroupoperator= (const LayoutGroup& src)
 
LayoutGroupoperator= (LayoutGroup&& src)=delete
 
virtual ~LayoutGroup ()
 
bool has_field (const Glib::ustring& parent_table_name, const Glib::ustring& table_name, const Glib::ustring& field_name) const
 Discover whether the layout group contains the specified field (from the current table). More...
 
bool has_any_fields () const
 Discover whether the layout group contains any fields. More...
 
void add_item (const std::shared_ptr< LayoutItem >& item)
 Add the item to the end of the list. More...
 
void add_item (const std::shared_ptr< LayoutItem >& item, const std::shared_ptr< const LayoutItem >& position)
 Add the item after the specified existing item. More...
 
void remove_item (const std::shared_ptr< LayoutItem >& item)
 Remove a layout item from the group. More...
 
void remove_field (const Glib::ustring& parent_table_name, const Glib::ustring& table_name, const Glib::ustring& field_name)
 Remove any instance of the field from the layout. More...
 
virtual void change_field_item_name (const Glib::ustring& table_name, const Glib::ustring& field_name, const Glib::ustring& field_name_new)
 
virtual void change_related_field_item_name (const Glib::ustring& table_name, const Glib::ustring& field_name, const Glib::ustring& field_name_new)
 
virtual void remove_relationship (const std::shared_ptr< const Relationship >& relationship)
 Remove any use of the relationship from the layout. More...
 
void remove_all_items ()
 
double get_border_width () const
 
void set_border_width (double border_width)
 
guint get_items_count () const
 
guint get_columns_count () const
 
void set_columns_count (guint columns_count)
 
type_list_items get_items ()
 
type_list_const_items get_items () const
 
type_list_const_items get_items_recursive () const
 Get the items recursively, depth-first, not returning any groups. More...
 
type_list_items get_items_recursive ()
 Get the items recursively, depth-first, not returning any groups. More...
 
type_list_const_items get_items_recursive_with_groups () const
 Get the items recursively, depth-first, also returning the groups. 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 ()
 
bool operator== (const LayoutItem& src) const
 
virtual bool get_editable () const
 
virtual void set_editable (bool val=true)
 
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
 

Additional Inherited Members

- 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...
 
- Public Attributes inherited from Glom::LayoutGroup
type_list_items m_list_items
 
- Protected Attributes inherited from Glom::TranslatableItem
enumTranslatableItemType m_translatable_item_type
 

Detailed Description

The child items are fields to be shown for each record in the group.

The records are grouped by a specified field and there may be. secondary fields that are also shown for each group.

Member Typedef Documentation

Constructor & Destructor Documentation

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

Member Function Documentation

virtual LayoutItem* Glom::LayoutItem_GroupBy::clone ( ) const
virtual

Create a new copied instance.

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

Reimplemented from Glom::LayoutGroup.

std::shared_ptr<LayoutItem_Field> Glom::LayoutItem_GroupBy::get_field_group_by ( )
std::shared_ptr<const LayoutItem_Field> Glom::LayoutItem_GroupBy::get_field_group_by ( ) const
type_list_sort_fields Glom::LayoutItem_GroupBy::get_fields_sort_by ( )
type_list_sort_fields Glom::LayoutItem_GroupBy::get_fields_sort_by ( ) const
bool Glom::LayoutItem_GroupBy::get_has_field_group_by ( ) const
bool Glom::LayoutItem_GroupBy::get_has_fields_sort_by ( ) const
virtual Glib::ustring Glom::LayoutItem_GroupBy::get_layout_display_name ( ) const
virtual

Get a text representation for the a layout.

Reimplemented from Glom::LayoutItem.

virtual Glib::ustring Glom::LayoutItem_GroupBy::get_part_type_name ( ) const
virtual

Reimplemented from Glom::LayoutGroup.

virtual Glib::ustring Glom::LayoutItem_GroupBy::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::LayoutGroup.

std::shared_ptr<LayoutGroup> Glom::LayoutItem_GroupBy::get_secondary_fields ( )
std::shared_ptr<const LayoutGroup> Glom::LayoutItem_GroupBy::get_secondary_fields ( ) const
LayoutItem_GroupBy& Glom::LayoutItem_GroupBy::operator= ( const LayoutItem_GroupBy src)
LayoutItem_GroupBy& Glom::LayoutItem_GroupBy::operator= ( LayoutItem_GroupBy&&  src)
delete
void Glom::LayoutItem_GroupBy::set_field_group_by ( const std::shared_ptr< LayoutItem_Field >&  field)
void Glom::LayoutItem_GroupBy::set_fields_sort_by ( const type_list_sort_fields field)

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