Binds model to box.
Connect to ActivateCursorRow signal.
Connect to MoveCursor signal.
Connect to RowActivated signal.
Connect to RowSelected signal.
Connect to SelectAll signal.
Connect to SelectedRowsChanged signal.
Connect to ToggleCursorRow signal.
Connect to UnselectAll signal.
This is a helper function for implementing DnD onto a #GtkListBox. The passed in row will be highlighted via gtk.widget.Widget.dragHighlight, and any previously highlighted row will be unhighlighted.
If a row has previously been highlighted via gtk.list_box.ListBox.dragHighlightRow it will have the highlight removed.
Returns whether rows activate on single clicks.
Gets the adjustment (if any) that the widget uses to for vertical scrolling.
Gets the n-th child in the list (not counting headers). If index is negative or larger than the number of items in the list, null is returned.
Gets the row at the y position.
Gets the selected row.
Creates a list of all selected children.
Gets the selection mode of the listbox.
Insert the child into the box at position. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of gtk.container.Container.add.
Update the filtering for all rows. Call this when result of the filter function on the box is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed.
Update the separators for all rows. Call this when result of the header function on the box is changed due to an external factor.
Update the sorting for all rows. Call this when result of the sort function on the box is changed due to an external factor.
Prepend a widget to the list. If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect of gtk.container.Container.add.
Select all children of box, if the selection mode allows it.
Make row the currently selected row.
Calls a function for each selected child.
Returns this, for use in with statements.
If single is true, rows will be activated when you click on them, otherwise you need to double-click.
Sets the adjustment (if any) that the widget uses to for vertical scrolling. For instance, this is used to get the page size for PageUp/Down key handling.
By setting a filter function on the box one can decide dynamically which of the rows to show. For instance, to implement a search function on a list that filters the original list to only show the matching rows.
By setting a header function on the box one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list. For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind.
Sets the placeholder widget that is shown in the list when it doesn't display any visible children.
Sets how selection works in the listbox. See #GtkSelectionMode for details.
By setting a sort function on the box one can dynamically reorder the rows of the list, based on the contents of the rows.
Unselect all children of box, if the selection mode allows it.
Unselects a single row of box, if the selection mode allows it.
Get builder for gtk.list_box.ListBox
Returns this, for use in with statements.
Get builder for gtk.container.Container
Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk.box.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
Gets the value of a child property for child and container.
Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.
Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.
Sets a child property for child and container.
Returns the type of the children supported by the container.
Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.
Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.
Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores null in focusable_widgets and returns false.
Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk.window.Window.getFocus.
Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.
Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
Returns the resize mode for the container. See gtk_container_set_resize_mode ().
When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.
Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
Sets the border width of the container.
Sets a focus chain, overriding the one computed automatically by GTK+.
Sets, or unsets if child is null, the focused child of container.
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.
Sets the reallocate_redraws flag of the container to the given value.
Sets the resize mode for the container.
Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.
Connect to Add signal.
Connect to CheckResize signal.
Connect to Remove signal.
Connect to SetFocusChild signal.
A GtkListBox is a vertical container that contains GtkListBoxRow children. These rows can be 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 GtkListBox is often an alternative to #GtkTreeView, especially when the list contents has a more complicated layout than what is allowed by a #GtkCellRenderer, or when the contents is interactive (i.e. has a button in it).
Although a #GtkListBox must have only #GtkListBoxRow children you can add any kind of widget to it via gtk.container.Container.add, and a #GtkListBoxRow widget will automatically be inserted between the list and the widget.
#GtkListBoxRows can be marked as activatable or selectable. If a row is activatable, #GtkListBox::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.
The GtkListBox widget was added in GTK+ 3.10.
GtkListBox as GtkBuildable
The GtkListBox implementation of the #GtkBuildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See gtk.list_box.ListBox.setPlaceholder for info.
CSS nodes
GtkListBox uses a single CSS node named list. Each GtkListBoxRow uses a single CSS node named row. The row nodes get the .activatable style class added when appropriate.