D.2. Functions

guint gtk_list_get_type( void );

Returns the "GtkList" type identifier.

GtkWidget *gtk_list_new( void );

Create a new List object. The new widget is returned as a pointer to a GtkWidget object. NULL is returned on failure.

void gtk_list_insert_items( GtkList *list,
                            GList   *items,
                            gint     position );

Insert list items into the list, starting at position. items is a doubly linked list where each nodes data pointer is expected to point to a newly created ListItem. The GList nodes of items are taken over by the list.

void gtk_list_append_items( GtkList *list,
                            GList   *items);

Insert list items just like gtk_list_insert_items() at the end of the list. The GList nodes of items are taken over by the list.

void gtk_list_prepend_items( GtkList *list,
                             GList   *items);

Insert list items just like gtk_list_insert_items() at the very beginning of the list. The GList nodes of items are taken over by the list.

void gtk_list_remove_items( GtkList *list,
                            GList   *items);

Remove list items from the list. items is a doubly linked list where each nodes data pointer is expected to point to a direct child of list. It is the callers responsibility to make a call to g_list_free(items) afterwards. Also the caller has to destroy the list items himself.

void gtk_list_clear_items( GtkList *list,
                           gint start,
                           gint end );

Remove and destroy list items from the list. A widget is affected if its current position within the list is in the range specified by start and end.

void gtk_list_select_item( GtkList *list,
                           gint     item );

Invoke the select_child signal for a list item specified through its current position within the list.

void gtk_list_unselect_item( GtkList *list,
                             gint     item);

Invoke the unselect_child signal for a list item specified through its current position within the list.

void gtk_list_select_child( GtkList *list,
                            GtkWidget *child);

Invoke the select_child signal for the specified child.

void gtk_list_unselect_child( GtkList   *list,
                              GtkWidget *child);

Invoke the unselect_child signal for the specified child.

gint gtk_list_child_position( GtkList *list,
                              GtkWidget *child);

Return the position of child within the list. "-1" is returned on failure.

void gtk_list_set_selection_mode( GtkList         *list,
                                  GtkSelectionMode mode );

Set the selection mode MODE which can be of GTK_SELECTION_SINGLE, GTK_SELECTION_BROWSE, GTK_SELECTION_MULTIPLE or GTK_SELECTION_EXTENDED.

GtkList *GTK_LIST( gpointer obj );

Cast a generic pointer to "GtkList *".

GtkListClass *GTK_LIST_CLASS( gpointer class);

Cast a generic pointer to "GtkListClass *".

gint GTK_IS_LIST( gpointer obj);

Determine if a generic pointer refers to a "GtkList" object.