Class: Gtk::Inscription

Inherits:
Widget
  • Object
show all
Defined in:
(unknown)

Instance Method Summary collapse

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_events, #add_events_raw, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #drag_dest_set, #drag_dest_set_raw, #drag_source_set, #drag_source_set_raw, #error_bell, #events, #events_raw, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #render_icon_pixbuf, #render_icon_pixbuf_raw, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_allocation, set_connect_func, set_connect_func_raw, #set_events, #set_events_raw, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #style_get_property, #style_get_property_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Constructor Details

#initialize(text) ⇒ Gtk::Widget

Creates a new GtkInscription with the given text.

Parameters:

  • text (String) —

    The text to display.

Instance Method Details

#attributes ⇒ Pango::AttrList

A list of style attributes to apply to the text of the inscription.

Returns:

  • (Pango::AttrList) —

    attributes

#attributes=(attributes) ⇒ Pango::AttrList

A list of style attributes to apply to the text of the inscription.

Parameters:

  • attributes (Pango::AttrList)

Returns:

  • (Pango::AttrList) —

    attributes

  • (Pango::AttrList) —

    attributes

#markup=(markup) ⇒ String

Utility property that sets both the [propertyGtk.Inscription:text] and [propertyGtk.Inscription:attributes] properties, mainly intended for use in GtkBuilder ui files to ease translation support and bindings.

This function uses [funcPango.parse_markup] to parse the markup into text and attributes. The markup must be valid. If you cannot ensure that, consider using [funcPango.parse_markup] and setting the two properties yourself.

Parameters:

  • markup (String)

Returns:

  • (String) —

    markup

#min_chars ⇒ Integer

The number of characters that should fit into the inscription at minimum.

This influences the requested width, not the width actually given to the widget, which might turn out to be larger.

Note that this is an approximate character width, so some characters might be wider and some might be thinner, so do not expect the number of characters to exactly match.

If you set this property to 0, the inscription will not request any width at all and its width will be determined entirely by its surroundings.

Returns:

  • (Integer) —

    min-chars

#min_chars=(min_chars) ⇒ Integer

The number of characters that should fit into the inscription at minimum.

This influences the requested width, not the width actually given to the widget, which might turn out to be larger.

Note that this is an approximate character width, so some characters might be wider and some might be thinner, so do not expect the number of characters to exactly match.

If you set this property to 0, the inscription will not request any width at all and its width will be determined entirely by its surroundings.

Parameters:

  • min_chars (Integer)

Returns:

  • (Integer) —

    min-chars

  • (Integer) —

    min-chars

#min_lines ⇒ Integer

The number of lines that should fit into the inscription at minimum.

This influences the requested height, not the height actually given to the widget, which might turn out to be larger.

Note that this is an approximate line height, so if the text uses things like fancy Unicode or attribute that influence the height, the text might not fit.

If you set this property to 0, the inscription will not request any height at all and its height will be determined entirely by its surroundings.

Returns:

  • (Integer) —

    min-lines

#min_lines=(min_lines) ⇒ Integer

The number of lines that should fit into the inscription at minimum.

This influences the requested height, not the height actually given to the widget, which might turn out to be larger.

Note that this is an approximate line height, so if the text uses things like fancy Unicode or attribute that influence the height, the text might not fit.

If you set this property to 0, the inscription will not request any height at all and its height will be determined entirely by its surroundings.

Parameters:

  • min_lines (Integer)

Returns:

  • (Integer) —

    min-lines

  • (Integer) —

    min-lines

#nat_chars ⇒ Integer

The number of characters that should ideally fit into the inscription.

This influences the requested width, not the width actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than [propertyGtk.Inscription:min-chars], that value will be used. In particular, for the default value of 0, this will always be the case.

Returns:

  • (Integer) —

    nat-chars

#nat_chars=(nat_chars) ⇒ Integer

The number of characters that should ideally fit into the inscription.

This influences the requested width, not the width actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than [propertyGtk.Inscription:min-chars], that value will be used. In particular, for the default value of 0, this will always be the case.

Parameters:

  • nat_chars (Integer)

Returns:

  • (Integer) —

    nat-chars

  • (Integer) —

    nat-chars

#nat_lines ⇒ Integer

The number of lines that should ideally fit into the inscription.

This influences the requested height, not the height actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than [propertyGtk.Inscription:min-lines], that value will be used. In particular, for the default value of 0, this will always be the case.

Returns:

  • (Integer) —

    nat-lines

#nat_lines=(nat_lines) ⇒ Integer

The number of lines that should ideally fit into the inscription.

This influences the requested height, not the height actually given to the widget. The widget might turn out larger as well as smaller.

If this property is set to a value smaller than [propertyGtk.Inscription:min-lines], that value will be used. In particular, for the default value of 0, this will always be the case.

Parameters:

  • nat_lines (Integer)

Returns:

  • (Integer) —

    nat-lines

  • (Integer) —

    nat-lines

#text ⇒ String

The displayed text.

Returns:

  • (String) —

    text

#text=(text) ⇒ String

The displayed text.

Parameters:

  • text (String)

Returns:

  • (String) —

    text

  • (String) —

    text

#text_overflow ⇒ Gtk::InscriptionOverflow

The overflow method to use for the text.

Returns:

#text_overflow=(text_overflow) ⇒ Gtk::InscriptionOverflow

The overflow method to use for the text.

Parameters:

Returns:

#wrap_mode ⇒ Pango::WrapMode

Controls how the line wrapping is done.

Note that unlike GtkLabel, the default here is %PANGO_WRAP_WORD_CHAR.

Returns:

  • (Pango::WrapMode) —

    wrap-mode

#wrap_mode=(wrap_mode) ⇒ Pango::WrapMode

Controls how the line wrapping is done.

Note that unlike GtkLabel, the default here is %PANGO_WRAP_WORD_CHAR.

Parameters:

  • wrap_mode (Pango::WrapMode)

Returns:

  • (Pango::WrapMode) —

    wrap-mode

  • (Pango::WrapMode) —

    wrap-mode

#xalign ⇒ Gtk::gfloat

The horizontal alignment of the text inside the allocated size.

Compare this to [propertyGtk.Widget:halign], which determines how the inscription's size allocation is positioned in the available space.

Returns:

  • (Gtk::gfloat) —

    xalign

#xalign=(xalign) ⇒ Gtk::gfloat

The horizontal alignment of the text inside the allocated size.

Compare this to [propertyGtk.Widget:halign], which determines how the inscription's size allocation is positioned in the available space.

Parameters:

  • xalign (Gtk::gfloat)

Returns:

  • (Gtk::gfloat) —

    xalign

  • (Gtk::gfloat) —

    xalign

#yalign ⇒ Gtk::gfloat

The vertical alignment of the text inside the allocated size.

Compare this to [propertyGtk.Widget:valign], which determines how the inscription's size allocation is positioned in the available space.

Returns:

  • (Gtk::gfloat) —

    yalign

#yalign=(yalign) ⇒ Gtk::gfloat

The vertical alignment of the text inside the allocated size.

Compare this to [propertyGtk.Widget:valign], which determines how the inscription's size allocation is positioned in the available space.

Parameters:

  • yalign (Gtk::gfloat)

Returns:

  • (Gtk::gfloat) —

    yalign

  • (Gtk::gfloat) —

    yalign