GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkListItem

## Name

GtkListItem -- an item in a GtkList.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkListItem;
    GtkWidget*  gtk_list_item_new               (void);
    GtkWidget*  gtk_list_item_new_with_label    (const gchar *label);
    void        gtk_list_item_select            (GtkListItem *list_item);
    void        gtk_list_item_deselect          (GtkListItem *list_item);

## Object Hierarchy

      GObject
       +----GtkObject
             +----GtkWidget
                   +----GtkContainer
                         +----GtkBin
                               +----GtkItem
                                     +----GtkListItem

## Signal Prototypes

    "end-selection"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "extend-selection"
                void        user_function      (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gboolean auto_start_selection,
                                                gpointer user_data);
    "scroll-horizontal"
                void        user_function      (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gpointer user_data);
    "scroll-vertical"
                void        user_function      (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gpointer user_data);
    "select-all"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "start-selection"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "toggle-add-mode"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "toggle-focus-row"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "undo-selection"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);
    "unselect-all"
                void        user_function      (GtkListItem *listitem,
                                                gpointer user_data);

## Description

The GtkListItem widget is used for each item in a GtkList.

## Details

### struct GtkListItem

    struct GtkListItem;

Warning
`GtkListItem` is deprecated and should not be used in newly-written code.

The GtkListItem struct contains private data only, and should only be accessed using the functions below.

### gtk_list_item_new ()

    GtkWidget*  gtk_list_item_new               (void);

Warning
`gtk_list_item_new` is deprecated and should not be used in newly-written code.

Creates a new GtkListitem.

Returns : | a new GtkListItem.

### gtk_list_item_new_with_label ()

    GtkWidget*  gtk_list_item_new_with_label    (const gchar *label);

Warning
`gtk_list_item_new_with_label` is deprecated and should not be used in newly-written code.

Creates a new GtkListItem with a child label containing the given string.

`label` : | the string to use for the child label.
Returns : | a new GtkListItem with a child GtkLabel with the text set to `label`.

### gtk_list_item_select ()

    void        gtk_list_item_select            (GtkListItem *list_item);

Warning
`gtk_list_item_select` is deprecated and should not be used in newly-written code.

Selects the item, by emitting the item's "select" signal. Depending on the selection mode of the list, this may cause other items to be deselected.

`list_item` : | a GtkListItem.

### gtk_list_item_deselect ()

    void        gtk_list_item_deselect          (GtkListItem *list_item);

Warning
`gtk_list_item_deselect` is deprecated and should not be used in newly-written code.

Deselects the item, by emitting the item's "deselect" signal.

`list_item` : | a GtkListItem.

## Signals

### The "end-selection" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "extend-selection" signal

    void        user_function                  (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gboolean auto_start_selection,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`scroll_type` : |
`position` : |
`auto_start_selection` : |
`user_data` : | user data set when the signal handler was connected.

### The "scroll-horizontal" signal

    void        user_function                  (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`scroll_type` : |
`position` : |
`user_data` : | user data set when the signal handler was connected.

### The "scroll-vertical" signal

    void        user_function                  (GtkListItem *listitem,
                                                GtkScrollType scroll_type,
                                                gfloat position,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`scroll_type` : |
`position` : |
`user_data` : | user data set when the signal handler was connected.

### The "select-all" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "start-selection" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "toggle-add-mode" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "toggle-focus-row" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "undo-selection" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "unselect-all" signal

    void        user_function                  (GtkListItem *listitem,
                                                gpointer user_data);

`listitem` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

## See Also

GtkList

  the parent list widget.

<<< Previous Page | Home | Up | Next Page >>>
GtkList | GtkPixmap