libglom-1.22  1.22.0
Public Types | Public Member Functions | Public Attributes
Glom::Formatting Class Reference

This specifies how to display data for fields or static text items. More...

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

List of all members.

Public Types

enum  HorizontalAlignment {
  HORIZONTAL_ALIGNMENT_AUTO,
  HORIZONTAL_ALIGNMENT_LEFT,
  HORIZONTAL_ALIGNMENT_RIGHT
}
typedef std::vector< sharedptr
< ChoiceValue > > 
type_list_values
typedef std::pair< sharedptr
< const LayoutItem_Field >
, bool > 
type_pair_sort_field
typedef std::vector
< type_pair_sort_field
type_list_sort_fields

Public Member Functions

 Formatting ()
 Formatting (const Formatting& src)
Formattingoperator= (const Formatting& src)
virtual ~Formatting ()
bool operator== (const Formatting& src) const
bool get_has_choices () const
bool get_has_related_choices () const
bool get_has_related_choices (bool& show_all, bool& with_second) const
void set_has_related_choices (bool val=true)
bool get_has_custom_choices () const
void set_has_custom_choices (bool val=true)
virtual type_list_values get_choices_custom () const
virtual void set_choices_custom (const type_list_values& choices)
Glib::ustring get_custom_choice_original_for_translated_text (const Glib::ustring& text, const Glib::ustring& locale=Glib::ustring()) const
 Get the original text that corresponds to the translated choice for the current locale.
Glib::ustring get_custom_choice_translated (const Glib::ustring& original_text, const Glib::ustring& locale=Glib::ustring()) const
 Get the translated choice text, for the current locale, that corresponds to the original text .
bool get_choices_restricted (bool& as_radio_buttons) const
 Discover whether the entered data should only be one of the available choices.
void set_choices_restricted (bool val=true, bool as_radio_buttons=false)
 See get_choices_restricted().
void get_choices_related (sharedptr< const Relationship >& relationship, sharedptr< LayoutItem_Field >& field, sharedptr< LayoutGroup >& extra_layout, type_list_sort_fields& sort_fields, bool& show_all)
void get_choices_related (sharedptr< const Relationship >& relationship, sharedptr< const LayoutItem_Field >& field, sharedptr< const LayoutGroup >& extra_layout, type_list_sort_fields& sort_fields, bool& show_all) const
void set_choices_related (const sharedptr< const Relationship >& relationship_name, const sharedptr< LayoutItem_Field >& field, const sharedptr< LayoutGroup >& extra_layout, const type_list_sort_fields& sort_fields, bool show_all)
sharedptr< const Relationshipget_choices_related_relationship (bool& show_all) const
bool get_text_format_multiline () const
 Get whether the text should be displayed with multiple lines in the details view.
void set_text_format_multiline (bool value=true)
 Set whether the text should be displayed with multiple lines in the details view.
guint get_text_format_multiline_height_lines () const
 Get the number of lines of text that should be displayed.
void set_text_format_multiline_height_lines (guint value)
 Get the number of lines of text that should be displayed.
void set_text_format_font (const Glib::ustring& font_desc)
 Set the font description, as returned from Gtk::FontButton::get_font_name(), which may include the size and style.
Glib::ustring get_text_format_font () const
 Get the font description, as returned from Gtk::FontButton::get_font_name(), which may include the size and style.
void set_text_format_color_foreground (const Glib::ustring& color)
 Set the foreground color to use for text when displaying a field value.
Glib::ustring get_text_format_color_foreground_to_use (const Gnome::Gda::Value&value) const
 Get the foreground color to use for text for the specified value, taking the negative-color into account, if specified.
Glib::ustring get_text_format_color_foreground () const
 Get the foreground color to use for text when displaying a field value.
void set_text_format_color_background (const Glib::ustring& color)
 Set the background color to use for text when displaying a field value.
Glib::ustring get_text_format_color_background () const
 Get the background color to use for text when displaying a field value.
void set_horizontal_alignment (HorizontalAlignment alignment)
HorizontalAlignment get_horizontal_alignment () const
bool change_field_item_name (const Glib::ustring& table_name, const Glib::ustring& field_name_old, const Glib::ustring& field_name_new)
 Adapt to a change of field name, so this Formatting does not refer to any field that no longer exists.

Public Attributes

NumericFormat m_numeric_format

Detailed Description

This specifies how to display data for fields or static text items.


Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
HORIZONTAL_ALIGNMENT_AUTO 
HORIZONTAL_ALIGNMENT_LEFT 
HORIZONTAL_ALIGNMENT_RIGHT 

Constructor & Destructor Documentation

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

Member Function Documentation

bool Glom::Formatting::change_field_item_name ( const Glib::ustring table_name,
const Glib::ustring field_name_old,
const Glib::ustring field_name_new 
)

Adapt to a change of field name, so this Formatting does not refer to any field that no longer exists.

Returns:
true if something was changed.
void Glom::Formatting::get_choices_related ( sharedptr< const Relationship >&  relationship,
sharedptr< LayoutItem_Field >&  field,
sharedptr< LayoutGroup >&  extra_layout,
type_list_sort_fields sort_fields,
bool &  show_all 
)
void Glom::Formatting::get_choices_related ( sharedptr< const Relationship >&  relationship,
sharedptr< const LayoutItem_Field >&  field,
sharedptr< const LayoutGroup >&  extra_layout,
type_list_sort_fields sort_fields,
bool &  show_all 
) const
bool Glom::Formatting::get_choices_restricted ( bool &  as_radio_buttons) const

Discover whether the entered data should only be one of the available choices.

Parameters:
[out]as_radio_buttons,:Whether the choices should be displayed as radio buttons instead of a combo box.

Get the original text that corresponds to the translated choice for the current locale.

Get the translated choice text, for the current locale, that corresponds to the original text .

bool Glom::Formatting::get_has_related_choices ( bool &  show_all,
bool &  with_second 
) const

Get the background color to use for text when displaying a field value.

Returns:
the text background color, in a format recognised by XParseColor

Get the foreground color to use for text when displaying a field value.

This should be overriden by m_numeric_formatting.m_foreground_color_for_negatives if that is active.

Returns:
the text foreground color, in a format recognised by XParseColor

Get the foreground color to use for text for the specified value, taking the negative-color into account, if specified.

Returns:
the text foreground color, in a format recognised by XParseColor

Get the font description, as returned from Gtk::FontButton::get_font_name(), which may include the size and style.

Returns:
a Pango font description string

Get whether the text should be displayed with multiple lines in the details view.

Text is displayed with a single line in the list view.

Returns:
whether the text should be displayed with multiple lines

Get the number of lines of text that should be displayed.

See also:
get_text_format_multiline()
Returns:
the number of lines of text
Formatting& Glom::Formatting::operator= ( const Formatting src)
bool Glom::Formatting::operator== ( const Formatting src) const
virtual void Glom::Formatting::set_choices_custom ( const type_list_values choices) [virtual]
void Glom::Formatting::set_choices_related ( const sharedptr< const Relationship >&  relationship_name,
const sharedptr< LayoutItem_Field >&  field,
const sharedptr< LayoutGroup >&  extra_layout,
const type_list_sort_fields sort_fields,
bool  show_all 
)
void Glom::Formatting::set_choices_restricted ( bool  val = true,
bool  as_radio_buttons = false 
)
void Glom::Formatting::set_has_custom_choices ( bool  val = true)
void Glom::Formatting::set_has_related_choices ( bool  val = true)

Set the background color to use for text when displaying a field value.

Parameters:
[in]colora text background color, in a format recognised by XParseColor

Set the foreground color to use for text when displaying a field value.

Parameters:
[in]colorthe text foreground color, in a format recognised by XParseColor

Set the font description, as returned from Gtk::FontButton::get_font_name(), which may include the size and style.

Parameters:
font_desca Pango font description string
void Glom::Formatting::set_text_format_multiline ( bool  value = true)

Set whether the text should be displayed with multiple lines in the details view.

Text is displayed with a single line in the list view.

Parameters:
[in]valuewhether the text should be displayed with multiple lines

Get the number of lines of text that should be displayed.

Returns:
the number of lines of text

Member Data Documentation


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