A single element in a GtkList.

Object Hierarchy

GtkObject
`-- GtkWidget
       `-- GtkContainer
              `-- GtkBin
                     `-- GtkItem
                            `-- GtkListItem

Direct subclasses

None.

Description

A GtkListItem is one of the elements that makes up a GtkList. It can consist of many things - see the constructor page - being basically a container with a specialised set of methods and signals.

GtkListItems are not equipped to carry data, unless you make it so. Using the GtkObject methods get_data() , remove_data() and set_data() is the usual way to achieve this. See GtkCombo for a working example.

The GtkListItem class supplies a multitude of signals to the list widget recursively, where they are treated as private signals and used internally. Several of these signals have keybindings, implemented here rather than in GtkList of necessity, which are described below.

Table 6. Key bindings used in GtkList

Key combination	Effect	Equivalent GtkList method
Up arrow	Scrolls up one step	scroll_vertical(GTK_SCROLL_STEP_BACKWARD, 0.0)
Down arrow	Scrolls down one step	scroll_vertical(GTK_SCROLL_STEP_FORWARD, 0.0)
Page Up	Scrolls up one page	scroll_vertical(GTK_SCROLL_PAGE_BACKWARD, 0.0)
Page Down	Scrolls down one page	scroll_vertical(GTK_SCROLL_PAGE_FORWARD, 0.0)
Control + Home	Scrolls to the top of the list	scroll_vertical(GTK_SCROLL_JUMP, 0.0)
Control + End	Scrolls to the end of the list	scroll_vertical(GTK_SCROLL_JUMP, 1.0)
Shift + Up arrow	Selects up one step	extend_selection(GTK_SCROLL_STEP_BACKWARD, 0.0, true)
Shift + Down arrow	Selects down one step	extend_selection(GTK_SCROLL_STEP_FORWARD, 0.0, true)
Shift + Page Up	Selects up one page	extend_selection(GTK_SCROLL_PAGE_BACKWARD, 0.0, true)
Shift + Page Down	Selects down one page	extend_selection(GTK_SCROLL_PAGE_FORWARD, 0.0, true)
Shift | Control + Home	Selects to the top of the list	extend_selection(GTK_SCROLL_JUMP, 0.0, true)
Shift | Control + End	Selects to the end of the list	extend_selection(GTK_SCROLL_JUMP, 1.0)
Left arrow	Scrolls one step to the left	scroll_horizontal(GTK_SCROLL_STEP_BACKWARD, 0.0)
Right arrow	Scrolls one step to the right	scroll_horizontal(GTK_SCROLL_STEP_FORWARD, 0.0)
Home	Scrolls to the left of the list	scroll_horizontal(GTK_SCROLL_JUMP, 0.0)
End	Scrolls to the right of the list	scroll_horizontal(GTK_SCROLL_JUMP, 1.0)
Escape	Returns to previous selection	undo_selection()
Space	Toggles state of row with current focus	toggle_focus_row()
Control + Space	Toggles whether further items can be selected	toggle_add_mode()
Control + /	Selects all items	select_all()
Control + \\	Deselects all items	unselect_all()
Shift_L + Release | Shift	Completes selection	end_selection()
Shift_R + Release | Shift	Completes selection	end_selection()
Shift_R + Release | Shift | Control	Completes selection	end_selection()

GtkListItem has been deprecated since GTK+ 2.0 and should not be used in newly written code.