libglom-1.22  1.21.8
Public Types | Public Member Functions | Public Attributes
Glom::LayoutGroup Class Reference
Inheritance diagram for Glom::LayoutGroup:
Inheritance graph
[legend]
Collaboration diagram for Glom::LayoutGroup:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::vector< sharedptr
< LayoutItem > > 
type_list_items
typedef std::vector< sharedptr
< const LayoutItem > > 
type_list_const_items

Public Member Functions

 LayoutGroup ()
 LayoutGroup (const LayoutGroup& src)
LayoutGroupoperator= (const LayoutGroup& src)
virtual ~LayoutGroup ()
virtual LayoutItemclone () const
 Create a new copied instance.
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).
bool has_any_fields () const
 Discover whether the layout group contains any fields.
void add_item (const sharedptr< LayoutItem >& item)
 Add the item to the end of the list.
void add_item (const sharedptr< LayoutItem >& item, const sharedptr< const LayoutItem >& position)
 Add the item after the specified existing item.
void remove_item (const sharedptr< LayoutItem >& item)
 Remove a layout item from the group.
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.
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 sharedptr< const Relationship >& relationship)
 Remove any use of the relationship from the layout.
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.
type_list_items get_items_recursive ()
 Get the items recursively, depth-first, not returning any groups.
type_list_const_items get_items_recursive_with_groups () const
 Get the items recursively, depth-first, also returning the groups.
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).

Public Attributes

type_list_items m_list_items

Member Typedef Documentation


Constructor & Destructor Documentation

virtual Glom::LayoutGroup::~LayoutGroup ( ) [virtual]

Member Function Documentation

Add the item to the end of the list.

Parameters:
itemThe item to add.
void Glom::LayoutGroup::add_item ( const sharedptr< LayoutItem >&  item,
const sharedptr< const LayoutItem >&  position 
)

Add the item after the specified existing item.

Parameters:
itemThe item to add.
positionThe item after which the item should be added.
virtual void Glom::LayoutGroup::change_field_item_name ( const Glib::ustring table_name,
const Glib::ustring field_name,
const Glib::ustring field_name_new 
) [virtual]
virtual void Glom::LayoutGroup::change_related_field_item_name ( const Glib::ustring table_name,
const Glib::ustring field_name,
const Glib::ustring field_name_new 
) [virtual]
virtual LayoutItem* Glom::LayoutGroup::clone ( ) const [virtual]

Get the items recursively, depth-first, not returning any groups.

Get the items recursively, depth-first, not returning any groups.

Get the items recursively, depth-first, also returning the groups.

This is only used by the tests so far.

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.

Reimplemented in Glom::LayoutItem_GroupBy, Glom::LayoutItem_Footer, Glom::LayoutItem_Header, Glom::LayoutItem_VerticalGroup, and Glom::LayoutItem_Summary.

Discover whether the layout group contains any fields.

Returns:
True if the field is in the layout group (or its child groups).
bool Glom::LayoutGroup::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).

Parameters:
parent_table_nameThe table to which this layout belongs.
table_nameThe table to which the field, specified by field_name, belongs.
field_nameThe name of the field to search for.
Returns:
True if the field is in the layout group (or its child groups).
LayoutGroup& Glom::LayoutGroup::operator= ( const LayoutGroup src)
void Glom::LayoutGroup::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.

Parameters:
parent_table_nameThe table to which this layout belongs.
table_nameThe table to which the field, specified by field_name, belongs.
field_nameThe name of the field to remove.

Remove a layout item from the group.

Parameters:
itemThe item to remove.
virtual void Glom::LayoutGroup::remove_relationship ( const sharedptr< const Relationship >&  relationship) [virtual]

Remove any use of the relationship from the layout.

void Glom::LayoutGroup::set_border_width ( double  border_width)
void Glom::LayoutGroup::set_columns_count ( guint  columns_count)

Member Data Documentation


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