Sets our main struct and passes it to the parent class
Creates a new GtkListBox container.
The ::row-activated signal is emitted when a row has been activated by the user. Since 3.10
The ::row-selected signal is emitted when a new row is selected, or (with a NULL row) when the selection is cleared. Since 3.10
This is a helper function for implementing DnD onto a GtkListBox. The passed in row will be highlighted via gtk_drag_highlight(), and any previously highlighted row will be unhighlighted. The row will also be unhighlighted when the widget gets a drag leave event.
If a row has previously been highlighted via gtk_list_box_drag_highlight_row() 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).
Gets the row at the y position.
Gets the selected row.
Gets the selection mode of the listbox.
the main Gtk struct as a void*
Insert the child into the list_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_add(). If position is -1, or larger than the total number of items in the list_box, then the child will be appended to the end.
Update the filtering for all rows. Call this when result of the filter function on the list_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 list_box is changed due to an external factor.
Update the sorting for all rows. Call this when result of the sort function on the list_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_add().
Make row the currently selected row.
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. In the normal case when the list_box is packed inside a GtkScrolledWindow the adjustment from that will be picked up automatically, so there is no need to manually do that.
By setting a filter function on the list_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. The filter_func will be called for each row after the call, and it will continue to be called each time a row changes (via gtk_list_box_row_changed()) or when gtk_list_box_invalidate_filter() is called.
By setting a header function on the list_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. The update_header can look at the current header widget using gtk_list_box_row_get_header() and either update the state of the widget as needed, or set a new one using gtk_list_box_row_set_header(). If no header is needed, set the header to NULL. Note that you may get many calls update_header to this for a particular row when e.g. changing things that don't affect the header. In this case it is important for performance to not blindly replace an exisiting header widh an identical one. The update_header function will be called for each row after the call, and it will continue to be called each time a row changes (via gtk_list_box_row_changed()) and when the row before changes (either by gtk_list_box_row_changed() on the previous row, or when the previous row becomes a different row). It is also called for all rows when gtk_list_box_invalidate_headers() is called.
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. Note: GtkListBox does not support GTK_SELECTION_MULTIPLE.
By setting a sort function on the list_box one can dynamically reorder the rows of the list, based on the contents of the rows. The sort_func will be called for each row after the call, and will continue to be called each time a row changes (via gtk_list_box_row_changed()) and when gtk_list_box_invalidate_sort() is called.
the main Gtk struct
the main Gtk struct
the main Gtk struct as a void*
Removes all widgets from the 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_pack_start() and gtk_grid_attach() as an alternative to gtk_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.
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 while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.
Returns the resize mode for the container. See gtk_container_set_resize_mode().
Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.
Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().
Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.
Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.
Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus(). Since 2.14
Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.
Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().
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_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.
Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().
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_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.
Warning gtk_container_resize_children is deprecated and should not be used in newly-written code. 3.10
Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.
Gets the value of a child property for child and container.
Sets a child property for child and container.
Gets the values of one or more child properties for child and container.
Sets one or more child properties for child and container.
Emits a "child-notify" signal for the child property child_property on widget. This is an analogue of g_object_notify() for child properties. Also see gtk_widget_child_notify().
Invokes callback on each 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. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). Virtual: forall
Retrieves the border width of the container. See gtk_container_set_border_width().
Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.
When a container receives a call to the draw function, it must send synthetic "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 "draw" function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received. gtk_container_propagate_draw() takes care of translating the origin of cr, and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling gtk_widget_draw() on the child directly. In most cases, a container can simply either inherit the "draw" implementation from GtkContainer, or do some drawing and then chain to the ::draw implementation from GtkContainer.
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.
Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.
Removes a focus chain explicitly set with gtk_container_set_focus_chain().
Finds a child property of a container class by name.
Installs a child property on a container class.
Returns all child properties of a container class.
Modifies a subclass of GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must "opt in" to the parent class handling border_width for them.
A GtkListBox is a vertical container that contains GtkListBoxRow 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 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_add(), and a GtkListBoxRow widget will automatically be inserted between the list and the widget.
The GtkListBox widget was added in GTK+ 3.10.