#include <gtk/gtkwidget.h>

Data Structures
struct	_GtkListBoxRow

struct	_GtkListBoxRowClass

Macros
#define	GTK_TYPE_LIST_BOX (gtk_list_box_get_type ())

#define	GTK_LIST_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_BOX, GtkListBox))

#define	GTK_IS_LIST_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_BOX))

#define	GTK_TYPE_LIST_BOX_ROW (gtk_list_box_row_get_type ())

#define	GTK_LIST_BOX_ROW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRow))

#define	GTK_LIST_BOX_ROW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRowClass))

#define	GTK_IS_LIST_BOX_ROW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_BOX_ROW))

#define	GTK_IS_LIST_BOX_ROW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LIST_BOX_ROW))

#define	GTK_LIST_BOX_ROW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRowClass))

Typedefs
typedef struct _GtkListBox	GtkListBox

typedef struct _GtkListBoxRow	GtkListBoxRow

typedef struct _GtkListBoxRowClass	GtkListBoxRowClass

typedef gboolean(*	GtkListBoxFilterFunc) (GtkListBoxRow *row, gpointer user_data)

typedef int(*	GtkListBoxSortFunc) (GtkListBoxRow row1, GtkListBoxRow row2, gpointer user_data)

typedef void(*	GtkListBoxUpdateHeaderFunc) (GtkListBoxRow row, GtkListBoxRow before, gpointer user_data)

typedef GtkWidget (	GtkListBoxCreateWidgetFunc) (gpointer item, gpointer user_data)

typedef void(*	GtkListBoxForeachFunc) (GtkListBox box, GtkListBoxRow row, gpointer user_data)

Functions
GDK_AVAILABLE_IN_ALL GType	gtk_list_box_row_get_type (void) G_GNUC_CONST

GDK_AVAILABLE_IN_ALL GtkWidget *	gtk_list_box_row_new (void)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_row_set_child (GtkListBoxRow row, GtkWidget child)

GDK_AVAILABLE_IN_ALL GtkWidget *	gtk_list_box_row_get_child (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL GtkWidget *	gtk_list_box_row_get_header (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_row_set_header (GtkListBoxRow row, GtkWidget header)

GDK_AVAILABLE_IN_ALL int	gtk_list_box_row_get_index (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_row_changed (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL gboolean	gtk_list_box_row_is_selected (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_row_set_selectable (GtkListBoxRow *row, gboolean selectable)

GDK_AVAILABLE_IN_ALL gboolean	gtk_list_box_row_get_selectable (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_row_set_activatable (GtkListBoxRow *row, gboolean activatable)

GDK_AVAILABLE_IN_ALL gboolean	gtk_list_box_row_get_activatable (GtkListBoxRow *row)

GDK_AVAILABLE_IN_ALL GType	gtk_list_box_get_type (void) G_GNUC_CONST

GDK_AVAILABLE_IN_ALL void	gtk_list_box_prepend (GtkListBox box, GtkWidget child)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_append (GtkListBox box, GtkWidget child)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_insert (GtkListBox box, GtkWidget child, int position)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_remove (GtkListBox box, GtkWidget child)

GDK_AVAILABLE_IN_4_12 void	gtk_list_box_remove_all (GtkListBox *box)

GDK_AVAILABLE_IN_ALL GtkListBoxRow *	gtk_list_box_get_selected_row (GtkListBox *box)

GDK_AVAILABLE_IN_ALL GtkListBoxRow *	gtk_list_box_get_row_at_index (GtkListBox *box, int index_)

GDK_AVAILABLE_IN_ALL GtkListBoxRow *	gtk_list_box_get_row_at_y (GtkListBox *box, int y)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_select_row (GtkListBox box, GtkListBoxRow row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_placeholder (GtkListBox box, GtkWidget placeholder)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_adjustment (GtkListBox box, GtkAdjustment adjustment)

GDK_AVAILABLE_IN_ALL GtkAdjustment *	gtk_list_box_get_adjustment (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_selected_foreach (GtkListBox *box, GtkListBoxForeachFunc func, gpointer data)

GDK_AVAILABLE_IN_ALL GList *	gtk_list_box_get_selected_rows (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_unselect_row (GtkListBox box, GtkListBoxRow row)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_select_all (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_unselect_all (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_selection_mode (GtkListBox *box, GtkSelectionMode mode)

GDK_AVAILABLE_IN_ALL GtkSelectionMode	gtk_list_box_get_selection_mode (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_filter_func (GtkListBox *box, GtkListBoxFilterFunc filter_func, gpointer user_data, GDestroyNotify destroy)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_header_func (GtkListBox *box, GtkListBoxUpdateHeaderFunc update_header, gpointer user_data, GDestroyNotify destroy)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_invalidate_filter (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_invalidate_sort (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_invalidate_headers (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_sort_func (GtkListBox *box, GtkListBoxSortFunc sort_func, gpointer user_data, GDestroyNotify destroy)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_activate_on_single_click (GtkListBox *box, gboolean single)

GDK_AVAILABLE_IN_ALL gboolean	gtk_list_box_get_activate_on_single_click (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_drag_unhighlight_row (GtkListBox *box)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_drag_highlight_row (GtkListBox box, GtkListBoxRow row)

GDK_AVAILABLE_IN_ALL GtkWidget *	gtk_list_box_new (void)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_bind_model (GtkListBox box, GListModel model, GtkListBoxCreateWidgetFunc create_widget_func, gpointer user_data, GDestroyNotify user_data_free_func)

GDK_AVAILABLE_IN_ALL void	gtk_list_box_set_show_separators (GtkListBox *box, gboolean show_separators)

GDK_AVAILABLE_IN_ALL gboolean	gtk_list_box_get_show_separators (GtkListBox *box)

Macro Definition Documentation

◆ GTK_IS_LIST_BOX

#define GTK_IS_LIST_BOX ( obj ) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_BOX))

Definition at line 35 of file gtklistbox.h.

◆ GTK_IS_LIST_BOX_ROW

#define GTK_IS_LIST_BOX_ROW ( obj ) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_LIST_BOX_ROW))

Definition at line 44 of file gtklistbox.h.

◆ GTK_IS_LIST_BOX_ROW_CLASS

#define GTK_IS_LIST_BOX_ROW_CLASS ( klass ) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_LIST_BOX_ROW))

Definition at line 45 of file gtklistbox.h.

◆ GTK_LIST_BOX

#define GTK_LIST_BOX ( obj ) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_BOX, GtkListBox))

Definition at line 34 of file gtklistbox.h.

◆ GTK_LIST_BOX_ROW

#define GTK_LIST_BOX_ROW ( obj ) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRow))

Definition at line 42 of file gtklistbox.h.

◆ GTK_LIST_BOX_ROW_CLASS

#define GTK_LIST_BOX_ROW_CLASS ( klass ) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRowClass))

Definition at line 43 of file gtklistbox.h.

◆ GTK_LIST_BOX_ROW_GET_CLASS

#define GTK_LIST_BOX_ROW_GET_CLASS ( obj ) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_LIST_BOX_ROW, GtkListBoxRowClass))

Definition at line 46 of file gtklistbox.h.

◆ GTK_TYPE_LIST_BOX

#define GTK_TYPE_LIST_BOX (gtk_list_box_get_type ())

Definition at line 33 of file gtklistbox.h.

◆ GTK_TYPE_LIST_BOX_ROW

#define GTK_TYPE_LIST_BOX_ROW (gtk_list_box_row_get_type ())

Definition at line 41 of file gtklistbox.h.

Typedef Documentation

◆ GtkListBox

typedef struct _GtkListBox GtkListBox

Definition at line 37 of file gtklistbox.h.

◆ GtkListBoxCreateWidgetFunc

typedef GtkWidget *(* GtkListBoxCreateWidgetFunc) (gpointer item, gpointer user_data)

GtkListBoxCreateWidgetFunc: @item: (type GObject): the item from the model for which to create a widget for @user_data: (closure): user data

Called for list boxes that are bound to a GListModel with gtk_list_box_bind_model() for each item that gets added to the model.

If the widget returned is not a GtkListBoxRow widget, then the widget will be inserted as the child of an intermediate GtkListBoxRow.

Returns: (transfer full): a GtkWidget that represents @item

Definition at line 128 of file gtklistbox.h.

◆ GtkListBoxFilterFunc

typedef gboolean(* GtkListBoxFilterFunc) (GtkListBoxRow *row, gpointer user_data)

GtkListBoxFilterFunc: @row: the row that may be filtered @user_data: (closure): user data

Will be called whenever the row changes or is added and lets you control if the row should be visible or not.

Returns: TRUE if the row should be visible, FALSE otherwise

Definition at line 81 of file gtklistbox.h.

◆ GtkListBoxForeachFunc

typedef void(* GtkListBoxForeachFunc) (GtkListBox *box, GtkListBoxRow *row, gpointer user_data)

Definition at line 206 of file gtklistbox.h.

◆ GtkListBoxRow

typedef struct _GtkListBoxRow GtkListBoxRow

Definition at line 38 of file gtklistbox.h.

◆ GtkListBoxRowClass

typedef struct _GtkListBoxRowClass GtkListBoxRowClass

Definition at line 39 of file gtklistbox.h.

◆ GtkListBoxSortFunc

typedef int(* GtkListBoxSortFunc) (GtkListBoxRow *row1, GtkListBoxRow *row2, gpointer user_data)

GtkListBoxSortFunc: @row1: the first row @row2: the second row @user_data: (closure): user data

Compare two rows to determine which should be first.

Returns: < 0 if @row1 should be before @row2, 0 if they are equal and > 0 otherwise

Definition at line 95 of file gtklistbox.h.

◆ GtkListBoxUpdateHeaderFunc

typedef void(* GtkListBoxUpdateHeaderFunc) (GtkListBoxRow *row, GtkListBoxRow *before, gpointer user_data)

GtkListBoxUpdateHeaderFunc: @row: the row to update @before: (nullable): the row before @row, or NULL if it is first @user_data: (closure): user data

Whenever @row changes or which row is before @row changes this is called, which lets you update the header on @row.

You may remove or set a new one via [metho.nosp@m.d@Gt.nosp@m.k.Lis.nosp@m.tBox.nosp@m.Row.s.nosp@m.et_h.nosp@m.eader] or just change the state of the current header widget.

Definition at line 111 of file gtklistbox.h.

Function Documentation

◆ gtk_list_box_append()

GDK_AVAILABLE_IN_ALL void gtk_list_box_append	(	GtkListBox *	box,
		GtkWidget *	child )

◆ gtk_list_box_bind_model()

GDK_AVAILABLE_IN_ALL void gtk_list_box_bind_model	(	GtkListBox *	box,
		GListModel *	model,
		GtkListBoxCreateWidgetFunc	create_widget_func,
		gpointer	user_data,
		GDestroyNotify	user_data_free_func )

◆ gtk_list_box_drag_highlight_row()

GDK_AVAILABLE_IN_ALL void gtk_list_box_drag_highlight_row	(	GtkListBox *	box,
		GtkListBoxRow *	row )

◆ gtk_list_box_drag_unhighlight_row()

GDK_AVAILABLE_IN_ALL void gtk_list_box_drag_unhighlight_row ( GtkListBox * box )

◆ gtk_list_box_get_activate_on_single_click()

GDK_AVAILABLE_IN_ALL gboolean gtk_list_box_get_activate_on_single_click ( GtkListBox * box )

◆ gtk_list_box_get_adjustment()

GDK_AVAILABLE_IN_ALL GtkAdjustment * gtk_list_box_get_adjustment ( GtkListBox * box )

◆ gtk_list_box_get_row_at_index()

GDK_AVAILABLE_IN_ALL GtkListBoxRow * gtk_list_box_get_row_at_index	(	GtkListBox *	box,
		int	index_ )

◆ gtk_list_box_get_row_at_y()

GDK_AVAILABLE_IN_ALL GtkListBoxRow * gtk_list_box_get_row_at_y	(	GtkListBox *	box,
		int	y )

◆ gtk_list_box_get_selected_row()

GDK_AVAILABLE_IN_ALL GtkListBoxRow * gtk_list_box_get_selected_row ( GtkListBox * box )

◆ gtk_list_box_get_selected_rows()

GDK_AVAILABLE_IN_ALL GList * gtk_list_box_get_selected_rows ( GtkListBox * box )

◆ gtk_list_box_get_selection_mode()

GDK_AVAILABLE_IN_ALL GtkSelectionMode gtk_list_box_get_selection_mode ( GtkListBox * box )

◆ gtk_list_box_get_show_separators()

GDK_AVAILABLE_IN_ALL gboolean gtk_list_box_get_show_separators ( GtkListBox * box )

◆ gtk_list_box_get_type()

GDK_AVAILABLE_IN_ALL GType gtk_list_box_get_type ( void )

◆ gtk_list_box_insert()

GDK_AVAILABLE_IN_ALL void gtk_list_box_insert	(	GtkListBox *	box,
		GtkWidget *	child,
		int	position )

◆ gtk_list_box_invalidate_filter()

GDK_AVAILABLE_IN_ALL void gtk_list_box_invalidate_filter ( GtkListBox * box )

◆ gtk_list_box_invalidate_headers()

GDK_AVAILABLE_IN_ALL void gtk_list_box_invalidate_headers ( GtkListBox * box )

◆ gtk_list_box_invalidate_sort()

GDK_AVAILABLE_IN_ALL void gtk_list_box_invalidate_sort ( GtkListBox * box )

◆ gtk_list_box_new()

GDK_AVAILABLE_IN_ALL GtkWidget * gtk_list_box_new ( void )

◆ gtk_list_box_prepend()

GDK_AVAILABLE_IN_ALL void gtk_list_box_prepend	(	GtkListBox *	box,
		GtkWidget *	child )

◆ gtk_list_box_remove()

GDK_AVAILABLE_IN_ALL void gtk_list_box_remove	(	GtkListBox *	box,
		GtkWidget *	child )

◆ gtk_list_box_remove_all()

GDK_AVAILABLE_IN_4_12 void gtk_list_box_remove_all ( GtkListBox * box )

◆ gtk_list_box_row_changed()

GDK_AVAILABLE_IN_ALL void gtk_list_box_row_changed ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_activatable()

GDK_AVAILABLE_IN_ALL gboolean gtk_list_box_row_get_activatable ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_child()

GDK_AVAILABLE_IN_ALL GtkWidget * gtk_list_box_row_get_child ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_header()

GDK_AVAILABLE_IN_ALL GtkWidget * gtk_list_box_row_get_header ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_index()

GDK_AVAILABLE_IN_ALL int gtk_list_box_row_get_index ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_selectable()

GDK_AVAILABLE_IN_ALL gboolean gtk_list_box_row_get_selectable ( GtkListBoxRow * row )

◆ gtk_list_box_row_get_type()

GDK_AVAILABLE_IN_ALL GType gtk_list_box_row_get_type ( void )

◆ gtk_list_box_row_is_selected()

GDK_AVAILABLE_IN_ALL gboolean gtk_list_box_row_is_selected ( GtkListBoxRow * row )

◆ gtk_list_box_row_new()

GDK_AVAILABLE_IN_ALL GtkWidget * gtk_list_box_row_new ( void )

◆ gtk_list_box_row_set_activatable()

GDK_AVAILABLE_IN_ALL void gtk_list_box_row_set_activatable	(	GtkListBoxRow *	row,
		gboolean	activatable )

◆ gtk_list_box_row_set_child()

GDK_AVAILABLE_IN_ALL void gtk_list_box_row_set_child	(	GtkListBoxRow *	row,
		GtkWidget *	child )

◆ gtk_list_box_row_set_header()

GDK_AVAILABLE_IN_ALL void gtk_list_box_row_set_header	(	GtkListBoxRow *	row,
		GtkWidget *	header )

◆ gtk_list_box_row_set_selectable()

GDK_AVAILABLE_IN_ALL void gtk_list_box_row_set_selectable	(	GtkListBoxRow *	row,
		gboolean	selectable )

◆ gtk_list_box_select_all()

GDK_AVAILABLE_IN_ALL void gtk_list_box_select_all ( GtkListBox * box )

◆ gtk_list_box_select_row()

GDK_AVAILABLE_IN_ALL void gtk_list_box_select_row	(	GtkListBox *	box,
		GtkListBoxRow *	row )

◆ gtk_list_box_selected_foreach()

GDK_AVAILABLE_IN_ALL void gtk_list_box_selected_foreach	(	GtkListBox *	box,
		GtkListBoxForeachFunc	func,
		gpointer	data )

◆ gtk_list_box_set_activate_on_single_click()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_activate_on_single_click	(	GtkListBox *	box,
		gboolean	single )

◆ gtk_list_box_set_adjustment()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_adjustment	(	GtkListBox *	box,
		GtkAdjustment *	adjustment )

◆ gtk_list_box_set_filter_func()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_filter_func	(	GtkListBox *	box,
		GtkListBoxFilterFunc	filter_func,
		gpointer	user_data,
		GDestroyNotify	destroy )

◆ gtk_list_box_set_header_func()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_header_func	(	GtkListBox *	box,
		GtkListBoxUpdateHeaderFunc	update_header,
		gpointer	user_data,
		GDestroyNotify	destroy )

◆ gtk_list_box_set_placeholder()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_placeholder	(	GtkListBox *	box,
		GtkWidget *	placeholder )

◆ gtk_list_box_set_selection_mode()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_selection_mode	(	GtkListBox *	box,
		GtkSelectionMode	mode )

◆ gtk_list_box_set_show_separators()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_show_separators	(	GtkListBox *	box,
		gboolean	show_separators )

◆ gtk_list_box_set_sort_func()

GDK_AVAILABLE_IN_ALL void gtk_list_box_set_sort_func	(	GtkListBox *	box,
		GtkListBoxSortFunc	sort_func,
		gpointer	user_data,
		GDestroyNotify	destroy )

◆ gtk_list_box_unselect_all()

GDK_AVAILABLE_IN_ALL void gtk_list_box_unselect_all ( GtkListBox * box )

◆ gtk_list_box_unselect_row()

GDK_AVAILABLE_IN_ALL void gtk_list_box_unselect_row	(	GtkListBox *	box,
		GtkListBoxRow *	row )

Data Structures

Macros

Typedefs

Functions