Inherits Glom::LayoutItem.
Inherited by Glom::LayoutItem_Footer, Glom::LayoutItem_GroupBy, Glom::LayoutItem_Header, Glom::LayoutItem_Notebook, Glom::LayoutItem_Portal, Glom::LayoutItem_Summary, and Glom::LayoutItem_VerticalGroup.
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) |
LayoutGroup& | operator= (const LayoutGroup& src) |
virtual | ~LayoutGroup () |
virtual LayoutItem* | clone () const |
| Create a new copied instance.
|
bool | has_field (const Glib::ustring& field_name) const |
| Discover whether the layout group contains the specified field.
|
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.
|
virtual void | remove_field (const Glib::ustring& field_name) |
| Remove any instance of the field (from the current table) from the layout.
|
virtual void | remove_field (const Glib::ustring& table_name, const Glib::ustring& field_name) |
| Remove any instance of the related 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.
|
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
Glom::LayoutGroup::LayoutGroup |
( |
|
) |
|
Glom::LayoutGroup::LayoutGroup |
( |
const LayoutGroup& |
src |
) |
|
virtual Glom::LayoutGroup::~LayoutGroup |
( |
|
) |
[virtual] |
Member Function Documentation
Add the item to the end of the list.
- Parameters:
-
Add the item after the specified existing item.
- Parameters:
-
| item | The item to add. |
| position | The item after which the item should be added. |
virtual LayoutItem* Glom::LayoutGroup::clone |
( |
|
) |
const [virtual] |
double Glom::LayoutGroup::get_border_width |
( |
|
) |
const |
guint Glom::LayoutGroup::get_columns_count |
( |
|
) |
const |
guint Glom::LayoutGroup::get_items_count |
( |
|
) |
const |
Get the items recursively, depth-first, not returning any groups.
Get the items recursively, depth-first, not returning any groups.
virtual Glib::ustring Glom::LayoutGroup::get_part_type_name |
( |
|
) |
const [virtual] |
virtual Glib::ustring Glom::LayoutGroup::get_report_part_id |
( |
|
) |
const [virtual] |
bool Glom::LayoutGroup::has_any_fields |
( |
|
) |
const |
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 & |
field_name |
) |
const |
Discover whether the layout group contains the specified field.
- Parameters:
-
| field_name | The name of the field to seach for. |
- Returns:
- True if the field is in the layout group (or its child groups).
void Glom::LayoutGroup::remove_all_items |
( |
|
) |
|
Remove any instance of the related field from the layout.
virtual void Glom::LayoutGroup::remove_field |
( |
const Glib::ustring & |
field_name |
) |
[virtual] |
Remove any instance of the field (from the current table) from the layout.
Remove a layout item from the group.
- Parameters:
-
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:
- libglom/data_structure/layout/layoutgroup.h