class Gtk::ListBox

• Gtk::ListBox
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

Gtk::ListBox is a vertical list.

A Gtk::ListBox only contains Gtk::ListBoxRow children. These rows can by dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.

Using Gtk::ListBox is often an alternative to Gtk::TreeView, especially when the list contents has a more complicated layout than what is allowed by a Gtk::CellRenderer, or when the contents is interactive (i.e. has a button in it).

Although a Gtk::ListBox must have only Gtk::ListBoxRow children, you can add any kind of widget to it via Gtk::ListBox#prepend, Gtk::ListBox#append and Gtk::ListBox#insert and a Gtk::ListBoxRow widget will automatically be inserted between the list and the widget.

Gtk::ListBoxRows can be marked as activatable or selectable. If a row is activatable, [signal@Gtk.ListBox::row-activated] will be emitted for it when the user tries to activate it. If it is selectable, the row will be marked as selected when the user tries to select it.

Gtk::ListBox as Gtk::Buildable

The Gtk::ListBox implementation of the Gtk::Buildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a element. See Gtk::ListBox#placeholder= for info.

CSS nodes

|[ list[.separators][.rich-list][.navigation-sidebar] ╰── row[.activatable] ]|

Gtk::ListBox uses a single CSS node named list. It may carry the .separators style class, when the [property@Gtk.ListBox:show-separators] property is set. Each Gtk::ListBoxRow uses a single CSS node named row. The row nodes get the .activatable style class added when appropriate.

The main list node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.

Accessibility

Gtk::ListBox uses the %GTK_ACCESSIBLE_ROLE_LIST role and Gtk::ListBoxRow uses the %GTK_ACCESSIBLE_ROLE_LIST_ITEM role.

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget

Defined in:

Constructors

• .new : self

  Creates a new Gtk::ListBox container.

• .new(*, accept_unpaired_release : Bool? = nil, accessible_role : Gtk::AccessibleRole? = nil, activate_on_single_click : Bool? = nil, can_focus : Bool? = nil, can_target : Bool? = nil, css_classes : Enumerable(String)? = nil, css_name : String? = nil, cursor : Gdk::Cursor? = nil, focus_on_click : Bool? = nil, focusable : Bool? = nil, halign : Gtk::Align? = nil, has_default : Bool? = nil, has_focus : Bool? = nil, has_tooltip : Bool? = nil, height_request : Int32? = nil, hexpand : Bool? = nil, hexpand_set : Bool? = nil, layout_manager : Gtk::LayoutManager? = nil, margin_bottom : Int32? = nil, margin_end : Int32? = nil, margin_start : Int32? = nil, margin_top : Int32? = nil, name : String? = nil, opacity : Float64? = nil, overflow : Gtk::Overflow? = nil, parent : Gtk::Widget? = nil, receives_default : Bool? = nil, root : Gtk::Root? = nil, scale_factor : Int32? = nil, selection_mode : Gtk::SelectionMode? = nil, sensitive : Bool? = nil, show_separators : Bool? = nil, tooltip_markup : String? = nil, tooltip_text : String? = nil, valign : Gtk::Align? = nil, vexpand : Bool? = nil, vexpand_set : Bool? = nil, visible : Bool? = nil, width_request : Int32? = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #accept_unpaired_release=(value : Bool) : Bool
• #accept_unpaired_release? : Bool
• #activate_cursor_row_signal
• #activate_on_single_click : Bool

  Returns whether rows activate on single clicks.

• #activate_on_single_click=(single : Bool) : Nil

  If @single is true, rows will be activated when you click on them, otherwise you need to double-click.

• #activate_on_single_click? : Bool
• #adjustment : Gtk::Adjustment?

  Gets the adjustment (if any) that the widget uses to for vertical scrolling.

• #adjustment=(adjustment : Gtk::Adjustment?) : Nil

  Sets the adjustment (if any) that the widget uses to for vertical scrolling.

• #append(child : Gtk::Widget) : Nil

  Append a widget to the list.

• #bind_model(model : Gio::ListModel?, create_widget_func : Gtk::ListBoxCreateWidgetFunc?) : Nil

  Binds @model to @box.

• #drag_highlight_row(row : Gtk::ListBoxRow) : Nil

  Add a drag highlight to a row.

• #drag_unhighlight_row : Nil

  If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.

• #filter_func=(filter_func : Gtk::ListBoxFilterFunc?) : Nil

  By setting a filter function on the @box one can decide dynamically which of the rows to show.

• #header_func=(update_header : Gtk::ListBoxUpdateHeaderFunc?) : Nil

  Sets a header function.

• #insert(child : Gtk::Widget, position : Int32) : Nil

  Insert the @child into the @box at @position.

• #invalidate_filter : Nil

  Update the filtering for all rows.

• #invalidate_headers : Nil

  Update the separators for all rows.

• #invalidate_sort : Nil

  Update the sorting for all rows.

• #move_cursor_signal
• #placeholder=(placeholder : Gtk::Widget?) : Nil

  Sets the placeholder widget that is shown in the list when it doesn't display any visible children.

• #prepend(child : Gtk::Widget) : Nil

  Prepend a widget to the list.

• #remove(child : Gtk::Widget) : Nil

  Removes a child from @box.

• #row_activated_signal
• #row_at_index(index_ : Int32) : Gtk::ListBoxRow?

  Gets the n-th child in the list (not counting headers).

• #row_at_y(y : Int32) : Gtk::ListBoxRow?

  Gets the row at the @y position.

• #row_selected_signal
• #select_all : Nil

  Select all children of @box, if the selection mode allows it.

• #select_all_signal
• #select_row(row : Gtk::ListBoxRow?) : Nil

  Make @row the currently selected row.

• #selected_foreach(func : Gtk::ListBoxForeachFunc, data : Pointer(Void)?) : Nil

  Calls a function for each selected child.

• #selected_row : Gtk::ListBoxRow?

  Gets the selected row, or nil if no rows are selected.

• #selected_rows : GLib::List

  Creates a list of all selected children.

• #selected_rows_changed_signal
• #selection_mode : Gtk::SelectionMode

  Gets the selection mode of the listbox.

• #selection_mode=(mode : Gtk::SelectionMode) : Nil

  Sets how selection works in the listbox.

• #show_separators : Bool

  Returns whether the list box should show separators between rows.

• #show_separators=(show_separators : Bool) : Nil

  Sets whether the list box should show separators between rows.

• #show_separators? : Bool
• #sort_func=(sort_func : Gtk::ListBoxSortFunc?) : Nil

  Sets a sort function.

• #toggle_cursor_row_signal
• #unselect_all : Nil

  Unselect all children of @box, if the selection mode allows it.

• #unselect_all_signal
• #unselect_row(row : Gtk::ListBoxRow) : Nil

  Unselects a single row of @box, if the selection mode allows it.

Constructor Detail

Class Method Detail

Instance Method Detail