|
| LayoutItem_Field () |
|
| LayoutItem_Field (const LayoutItem_Field& src) |
|
LayoutItem_Field& | operator= (const LayoutItem_Field& src) |
|
virtual | ~LayoutItem_Field () |
|
virtual LayoutItem* | clone () const |
| Create a new copied instance.
|
|
bool | operator== (const LayoutItem_Field& src) const |
|
virtual void | set_name (const Glib::ustring& name) |
| Set the non-user-visible name of the field.
|
|
virtual Glib::ustring | get_name () const |
| Get the non-user-visible name of the field.
|
|
virtual Glib::ustring | get_title (const Glib::ustring& locale) const |
| Get the user-visible title for the field, in the user's current locale.
|
|
virtual Glib::ustring | get_title_or_name (const Glib::ustring& locale) const |
| Get the user-visible title for the field, in the user's current locale.
|
|
Glib::ustring | get_title_or_name_no_custom (const Glib::ustring& locale) const |
|
sharedptr< const CustomTitle > | get_title_custom () const |
|
sharedptr< CustomTitle > | get_title_custom () |
|
void | set_title_custom (const sharedptr< CustomTitle >& title) |
|
virtual Glib::ustring | get_layout_display_name () const |
| Get a text representation for the field, such as Relationship::FieldName.
|
|
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).
|
|
void | set_full_field_details (const sharedptr< const Field >& field) |
|
sharedptr< const Field > | get_full_field_details () const |
|
Field::glom_field_type | get_glom_type () const |
| Convenience function, to avoid use of get_full_field_details().
|
|
bool | get_editable_and_allowed () const |
|
bool | get_hidden () const |
| For extra fields, needed for SQL queries. The user should never be able to make an item hidden - he can just remove it.
|
|
void | set_hidden (bool val=true) |
|
bool | get_formatting_use_default () const |
| Discover whether to use the default formatting for this field, instead of some custom per-layout-item field formatting.
|
|
void | set_formatting_use_default (bool use_default=true) |
| Specify whether to use the default formatting for this field, instead of some custom per-layout-item field formatting.
|
|
virtual const Formatting& | get_formatting_used () const |
| Get the field formatting used by this layout item, which may be either custom field formatting or the default field formatting.
|
|
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 HORIZONTAL_ALIGNMENT_AUTO.
|
|
bool | get_formatting_used_has_translatable_choices () const |
| A convenience method to discover whether the formatting that is used has custom choices with the values restricted to those choices, meaning that those choices could be translated.
|
|
bool | is_same_field (const sharedptr< const LayoutItem_Field >& field) const |
| Compare the name, relationship, and related_relationship.
|
|
| LayoutItem_WithFormatting () |
|
| LayoutItem_WithFormatting (const LayoutItem_WithFormatting& src) |
|
LayoutItem_WithFormatting& | operator= (const LayoutItem_WithFormatting& src) |
|
virtual | ~LayoutItem_WithFormatting () |
|
bool | operator== (const LayoutItem_WithFormatting& src) const |
|
| LayoutItem () |
|
| LayoutItem (const LayoutItem& src) |
|
LayoutItem& | operator= (const LayoutItem& src) |
|
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.
|
|
void | set_print_layout_position (double x, double y, double width, double height) |
| This is used only for the print layouts.
|
|
void | set_print_layout_position_y (double y) |
| This is used only for the print layouts.
|
|
void | set_print_layout_split_across_pages (bool split=true) |
| This is used only for the print layouts.
|
|
bool | get_print_layout_split_across_pages () const |
| This is used only for the print layouts.
|
|
| TranslatableItem () |
|
| TranslatableItem (const TranslatableItem& src) |
|
virtual | ~TranslatableItem () |
|
TranslatableItem& | operator= (const TranslatableItem& src) |
|
bool | operator== (const TranslatableItem& src) const |
|
bool | operator!= (const TranslatableItem& src) const |
|
bool | get_name_not_empty () const |
|
virtual Glib::ustring | get_title_original () const |
| Get the title's original (non-translated, usually English) text.
|
|
Glib::ustring | get_title_translation (const Glib::ustring& locale, bool fallback=true) const |
| 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.
|
|
void | set_title (const Glib::ustring& title, const Glib::ustring& locale) |
| Set the title's translation for the specified locale.
|
|
void | set_title_original (const Glib::ustring& title) |
| Set the title's original (non-translated, usually English) text.
|
|
void | clear_title_in_all_locales () |
| Clear the original title and any translations of the title.
|
|
bool | get_has_translations () const |
|
enumTranslatableItemType | get_translatable_item_type () const |
|
| UsesRelationship () |
|
| UsesRelationship (const UsesRelationship& src) |
|
UsesRelationship& | operator= (const UsesRelationship& src) |
|
virtual | ~UsesRelationship () |
|
bool | operator== (const UsesRelationship& src) const |
|
bool | get_has_relationship_name () const |
|
bool | get_has_related_relationship_name () const |
|
Glib::ustring | get_relationship_name () const |
| Convenience function, equivalent to get_relationship()->get_name().
|
|
Glib::ustring | get_related_relationship_name () const |
| Convenience function, equivalent to get_relationship()->get_name().
|
|
sharedptr< const Relationship > | get_relationship () const |
| Return the relationship used by this item, if any, or a null sharedptr.
|
|
void | set_relationship (const sharedptr< const Relationship >& relationship) |
|
sharedptr< const Relationship > | get_related_relationship () const |
| Return the related relationship used by this item, if any, or a null sharedptr.
|
|
void | set_related_relationship (const sharedptr< const Relationship >& relationship) |
|
Glib::ustring | get_table_used (const Glib::ustring& parent_table) const |
| Returns either the parent_table, related to table, or doubly-related to-table.
|
|
Glib::ustring | get_title_used (const Glib::ustring& parent_table_title, const Glib::ustring& locale) const |
| Get the title of the relationship that is actually used, falling back to the relationship's name.
|
|
Glib::ustring | get_title_singular_used (const Glib::ustring& parent_table_title, const Glib::ustring& locale) const |
| Get the singular title of the relationship that is actually used, falling back to the regular (plural) title, and then to the relationship's name.
|
|
Glib::ustring | get_to_field_used () const |
|
Glib::ustring | get_relationship_name_used () const |
| Get the name of the related relationship used, if any, or the relationship if there is no related relationship, or an empty string if neither are used by this item.
|
|
bool | get_relationship_used_allows_edit () const |
| Discover whether the relationship used allows the user to edit values in its to table.
|
|
Glib::ustring | get_sql_join_alias_name () const |
| Get a name to use as an alias in SQL statements.
|
|
Glib::ustring | get_sql_table_or_join_alias_name (const Glib::ustring& parent_table) const |
| Get the item's alias name, if it uses a relationship, or just get its table name.
|
|
Glib::ustring | get_relationship_display_name () const |
| Get a human-readable representation of th relationship.
|
|
A LayoutItem that shows the data from a table field.
The field may be in a known table, or in a to table of a relationship or related relatinoship. See UsesRelationship::get_relationship() and UsesRelationship::get_related_relationship() in the base class.
get_title() returns either the title of the Field or the CustomTitle. You should not call get/set_title_original() or get/set_title_translation() on items of this type.