Public Types | Public Member Functions

Glom::LayoutItem_Portal Class Reference

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

List of all members.

Public Types

enum  navigation_type {
  NAVIGATION_NONE,
  NAVIGATION_AUTOMATIC,
  NAVIGATION_SPECIFIC
}
 

The navigation (if any) that should be used when the user activates a related record row.

More...

Public Member Functions

 LayoutItem_Portal ()
 LayoutItem_Portal (const LayoutItem_Portal& src)
LayoutItem_Portaloperator= (const LayoutItem_Portal& src)
virtual ~LayoutItem_Portal ()
virtual LayoutItemclone () const
 Create a new copied instance.
virtual Glib::ustring get_part_type_name () const
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)
Glib::ustring get_from_table () const
 A helper method to avoid extra ifs to avoid null dereferencing.
sharedptr< UsesRelationshipget_navigation_relationship_specific ()
 Gets the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.
sharedptr< const UsesRelationshipget_navigation_relationship_specific () const
 Get the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.
void set_navigation_relationship_specific (const sharedptr< UsesRelationship >& relationship)
 Set the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.
void reset_navigation_relationship ()
navigation_type get_navigation_type () const
 Discover what type (if any) navigation should be used when the user activates a related record row.
void set_navigation_type (navigation_type type)
 Set what type (if any) navigation should be used when the user activates a related record row.
double get_print_layout_row_height () const
 This is used only for the print layouts.
void set_print_layout_row_height (double row_height)
 This is used only for the print layouts.

Member Enumeration Documentation

The navigation (if any) that should be used when the user activates a related record row.

Enumerator:
NAVIGATION_NONE 

No navigation will be offered.

NAVIGATION_AUTOMATIC 

The destination related table will be chosen automatically based on the relationship and the visible fields.

NAVIGATION_SPECIFIC 

The destination related table will be determined by a specified relationship.


Constructor & Destructor Documentation

Glom::LayoutItem_Portal::LayoutItem_Portal (  )
Glom::LayoutItem_Portal::LayoutItem_Portal ( const LayoutItem_Portal src )
virtual Glom::LayoutItem_Portal::~LayoutItem_Portal (  ) [virtual]

Member Function Documentation

virtual void Glom::LayoutItem_Portal::change_field_item_name ( const Glib::ustring table_name,
const Glib::ustring field_name,
const Glib::ustring field_name_new 
) [virtual]

Reimplemented from Glom::LayoutGroup.

Reimplemented in Glom::LayoutItem_CalendarPortal.

virtual void Glom::LayoutItem_Portal::change_related_field_item_name ( const Glib::ustring table_name,
const Glib::ustring field_name,
const Glib::ustring field_name_new 
) [virtual]

Reimplemented from Glom::LayoutGroup.

Reimplemented in Glom::LayoutItem_CalendarPortal.

virtual LayoutItem* Glom::LayoutItem_Portal::clone (  ) const [virtual]

Create a new copied instance.

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

Reimplemented from Glom::LayoutGroup.

Reimplemented in Glom::LayoutItem_CalendarPortal.

Glib::ustring Glom::LayoutItem_Portal::get_from_table (  ) const

A helper method to avoid extra ifs to avoid null dereferencing.

sharedptr<const UsesRelationship> Glom::LayoutItem_Portal::get_navigation_relationship_specific (  ) const

Get the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.

sharedptr<UsesRelationship> Glom::LayoutItem_Portal::get_navigation_relationship_specific (  )

Gets the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.

navigation_type Glom::LayoutItem_Portal::get_navigation_type (  ) const

Discover what type (if any) navigation should be used when the user activates a related record row.

virtual Glib::ustring Glom::LayoutItem_Portal::get_part_type_name (  ) const [virtual]

Reimplemented from Glom::LayoutGroup.

Reimplemented in Glom::LayoutItem_CalendarPortal.

double Glom::LayoutItem_Portal::get_print_layout_row_height (  ) const

This is used only for the print layouts.

LayoutItem_Portal& Glom::LayoutItem_Portal::operator= ( const LayoutItem_Portal src )
void Glom::LayoutItem_Portal::reset_navigation_relationship (  )
void Glom::LayoutItem_Portal::set_navigation_relationship_specific ( const sharedptr< UsesRelationship >&  relationship )

Set the relationship to use for navigation if get_navigation_type() is NAVIGATION_NONE.

void Glom::LayoutItem_Portal::set_navigation_type ( navigation_type  type )

Set what type (if any) navigation should be used when the user activates a related record row.

void Glom::LayoutItem_Portal::set_print_layout_row_height ( double  row_height )

This is used only for the print layouts.


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