Class: Gtk::ListBoxRow

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_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #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, #error_bell, #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, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #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, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_state_flags, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #template=, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #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 ⇒ Gtk::Widget

Creates a new GtkListBoxRow.

Instance Method Details

#activatable ⇒ Boolean

Gets whether the row is activatable.

Returns:

  • (Boolean) —

    true if the row is activatable

#activatable=(activatable) ⇒ Boolean

Determines whether the ::row-activated
signal will be emitted for this row.

Parameters:

  • activatable (Boolean)

Returns:

  • (Boolean) —

    activatable

  • (Boolean) —

    activatable

#activatable? ⇒ Boolean

Determines whether the ::row-activated
signal will be emitted for this row.

Returns:

  • (Boolean) —

    activatable

#changed ⇒ nil

Marks row as changed, causing any state that depends on this
to be updated.

This affects sorting, filtering and headers.

Note that calls to this method must be in sync with the data
used for the row functions. For instance, if the list is
mirroring some external data set, and two rows changed in the
external data set then when you call gtk_list_box_row_changed()
on the first row the sort function must only read the new data
for the first of the two changed rows, otherwise the resorting
of the rows will be wrong.

This generally means that if you don’t fully control the data
model you have to duplicate the data that affects the listbox
row functions into the row widgets themselves. Another alternative
is to call [methodGtk.ListBox.invalidate_sort] on any model change,
but that is more expensive.

Returns:

  • (nil)

#child ⇒ Gtk::Widget

The child widget.

Returns:

#child=(child) ⇒ Gtk::Widget

The child widget.

Parameters:

Returns:

#header ⇒ Gtk::Widget

Returns the current header of the row.

This can be used
in a [callbackGtk.ListBoxUpdateHeaderFunc] to see if
there is a header set already, and if so to update
the state of it.

Returns:

#header=(header) ⇒ nil

Sets the current header of the row.

This is only allowed to be called
from a [callbackGtk.ListBoxUpdateHeaderFunc].
It will replace any existing header in the row,
and be shown in front of the row in the listbox.

Parameters:

Returns:

  • (nil)

#index ⇒ Integer

Gets the current index of the row in its GtkListBox container.

Returns:

  • (Integer) —

    the index of the row, or -1 if the row is not in a listbox

#is_selected ⇒ Boolean

Returns whether the child is currently selected in its
GtkListBox container.

Returns:

  • (Boolean) —

    true if row is selected

#selectable ⇒ Boolean

Gets whether the row can be selected.

Returns:

  • (Boolean) —

    true if the row is selectable

#selectable=(selectable) ⇒ Boolean

Determines whether this row can be selected.

Parameters:

  • selectable (Boolean)

Returns:

  • (Boolean) —

    selectable

  • (Boolean) —

    selectable

#selectable? ⇒ Boolean

Determines whether this row can be selected.

Returns:

  • (Boolean) —

    selectable