14. IconView

A Gtk.IconView is a widget that displays a collection of icons in a grid view. It supports features such as drag and drop, multiple selections and item reordering.

Similarly to Gtk.TreeView, Gtk.IconView uses a Gtk.ListStore for its model. Instead of using cell renderers, Gtk.IconView requires that one of the columns in its Gtk.ListStore contains GdkPixbuf.Pixbuf objects.

Gtk.IconView supports numerous selection modes to allow for either selecting multiple icons at a time, restricting selections to just one item or disallowing selecting items completely. To specify a selection mode, the Gtk.IconView.set_selection_mode() method is used with one of the Gtk.SelectionMode selection modes.

14.1. IconView objects

class Gtk.IconView

static new_with_area(area)

Creates a new Gtk.IconView widget using the specified area to layout cells inside the icons.

static new_with_model(model)

Creates a new Gtk.IconView widget with the model model.

set_model(model)

Sets the model for a Gtk.IconView. If the Gtk.IconView already has a model set, it will remove it before setting the new model. If model is None, then it will unset the old model.

get_model()

Returns the model the Gtk.IconView is based on. Returns None if the model is unset.

set_text_column(column)

Sets the column with text to be column. The text column must be of type str.

get_text_column()

Return the column with text, or -1 if it’s unset.

set_markup_column(column)

Sets the column with markup information for the Gtk.IconView to be column. The markup column must be of type str. If the markup column is set to something, it overrides the text column set by set_text_column().

get_markup_column()

Returns the column with markup text, or -1 if it’s unset.

set_pixbuf_column(column)

Sets the column with pixbufs to be column. The pixbuf column must be of type GdkPixbuf.Pixbuf

get_pixbuf_column()

Returns the column with pixbufs, or -1 if it’s unset.

get_item_at_pos(x, y)

Finds the path at the point(x, y), relative to bin_window coordinates. In contrast to get_path_at_pos(), this method also obtains the cell at the specified position. See convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates.

convert_widget_to_bin_coords(x, y)

Converts widget coordinates to coordinates for the bin_window, as expected by e.g. get_path_at_pos()

set_cursor(path, cell, start_editing)

Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user’s attention on a particular item. If cell is not None, then focus is given to the cell specified by it. Additionally, if start_editing is True, then editing should be started in the specified cell.

This function is often followed by grab_focus() in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

get_cursor()

Returns the current cursor path and cell. If the cursor isn’t currently set, then path will be None. If no cell currently has focus, then cell will be None.

selected_foreach(func, data)

Calls a function for each selected icon. Note that the model or selection cannot be modified from within this method.

set_selection_mode(mode)

Sets the Gtk.SelectionMode of the Gtk.IconView.

get_selection_mode()

Gets the Gtk.SelectionMode of the Gtk.IconView.

set_item_orientation(orientation)

Sets the “item-orientation” property which determines whether the labels are drawn beside the icons instead of below.

get_item_orientation()

Returns the Gtk.Orientation of the “item-orientation” property which determines whether the labels are drawn beside the icons instead of below.

set_columns(columns)

Sets the “columns” property which determines in how many columns the icons are arranged. If columns is -1, the number of columns will be chosen automatically to fill the available area.

get_columns()

Returns the value of the “columns” property.

set_item_width(item_width)

Sets the “item-width” property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size.

get_item_width()

Returns the value of the “item-width” property.

set_spacing(spacing)

Sets the “spacing” property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.

set_row_spacing(row_spacing)

Sets the “row-spacing” property which specifies the space which is inserted between the rows of the icon view.

get_row_spacing()

Returns the value of the “row-spacing” property.

set_column_spacing(column_spacing)

Sets the “column-spacing” property which specifies the space which is inserted between the columns of the icon view.

get_column_spacing()

Returns the value of the “column-spacing” property.

set_margin(margin)

Sets the “margin” property which specifies the space which is inserted at the top, bottom, left and right of the icon view.

get_margin()

Returns the value of the “margin” property.

set_item_padding(item_padding)

Sets the “item-padding” property which specifies the padding around each of the icon view’s items.

get_item_padding()

Returns the value of the “item-padding property.

select_path(path)

Selects the row at path.

unselect_path(path)

Unselects the row at path.

path_is_selected(path)

Returns True if the icon pointed to by path is currently selected. If path does not point to a valid location, False is returned.

get_selected_items()

Creates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of Gtk.TreeRowReference.

select_all()

Selects all the icons. The Gtk.IconView must has its selection mode set to Gtk.SelectionMode.MULTIPLE

unselect_all()

Unselects all the icons.

scroll_to_path(path, use_align, row_align, col_align)

Moves the alignments of Gtk.IconView to the position specified by path. row_align determines where the row is placed, the col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

If use_align is False, the the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the item onto the screen. This means that the item will be scrolled to the edge closest to its current position. If the item is currently visible on the screen, nothing is done.

This function only works if the model is set, and path is a valid row on the model. If the model changes before the Gtk.IconView is realized, the centered path will be modified to reflect this change.

get_visible_range()

Returns the first and last visible Gtk.TreePath. Note that there may be invisible paths in between.

set_tooltip_item(tooltip, path)

Sets the tip area of tooltip to be the area covered by the item at path. See also set_tooltip_column() for a simpler alternative. See also Gtk.Tooltip.set_tip_area().

set_tooltip_cell(tooltip, path, cell)

Sets the tip area of tooltip to the area which cell occupies in the item pointed to by path. See also Gtk.Tooltip.set_tip_area()

See also set_tooltip_column() for a simpler alternative.

get_tooltip_context(x, y, keyboard_tip)

This function is supposed to be used in a “query-tooltip” signal handler for Gtk.IconView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this method without modification.

The return value indicates whether there is an icon view item at the given coordinates (True) or not (False) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. When True, then all of the items which have been returned will be set to point to that row and corresponding model. x and y will always be converted to be relative to the Gtk.IconView‘s bin_window if keyboard_tooltip is False.

set_tooltip_column(column)

If you only plan to have simple (text-only) tooltips on full items, you can use this function to have Gtk.IconView handle these automatically for you. column should be set to the column in the Gtk.IconView‘s model containing the tooltip texts, or -1 to disable this feature.

When enabled, “has-tooltip” will be set to True and Gtk.IconView will connect a “query-tooltip” signal handler.

Note that the signal handler sets the text with Gtk.Tooltip.set_markup(), so &, <, etc have to be escaped in the text.

get_tooltip_column()

Returns the column of Gtk.IconView‘s model which is being used for displaying tooltips on Gtk.IconView‘s rows, or -1 if this is disabled.

get_item_row(path)

Gets the row in which the item path is currently displayed. Row numbers start at 0.

get_item_column(path)

Gets the column in which the item path is currently displayed. Column numbers start at 0.

enable_model_drag_source(start_button_mask, targets, n_targets, actions)

Turns Gtk.IconView into a drag source for automatic DND. Calling this method sets “reorderable” to False.

enable_model_drag_dest(targets, n_targets, actions)

Turns Gtk.IconView into a drop destination for automatic DND. Calling this method sets “reorderable” to False.

unset_model_drag_source()

Undoes the effect of enable_model_drag_source(). Calling this method sets “reorderable” to False.

unset_model_drag_dest()

Undoes the effect of enable_model_drag_dest(). Calling this method sets “reorderable” to False.

set_reorderable(reorderable)

This method is a convenience method to allow you to reorder models that support the Gtk.TreeDragSource and the Gtk.TreeDragDest interfaces. Both Gtk.TreeStore and Gtk.ListStore support these. If reorderable is True, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting the model’s “row_inserted” and “row_deleted” signals. The reordering is implemented by setting up the icon view as drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.

This function does not give you any degree of control over the order – any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.

get_reorderable()

Retrieves whether the user can reorder the list via drag-and-drop. See set_reorderable().

set_drag_dest_item(path, pos)

Sets the item that is highlighted for feedback.

get_drag_dest_item()

Gets information about the item that is highlighted for feedback.

get_dest_item_at_pos(drag_x, drag_y)

Determines the destination item for a given position.

create_drag_icon(path)

Creates a Cairo.Surface representation of the item at path. This image is used for a drag icon.

14.2. Example

from gi.repository import Gtk
from gi.repository.GdkPixbuf import Pixbuf

icons = ["gtk-cut", "gtk-paste", "gtk-copy"]

class IconViewWindow(Gtk.Window):

  def __init__(self):
    Gtk.Window.__init__(self)
    self.set_default_size(200, 200)

    liststore = Gtk.ListStore(Pixbuf, str)
    iconview = Gtk.IconView.new()
    iconview.set_model(liststore)
    iconview.set_pixbuf_column(0)
    iconview.set_text_column(1)

    for icon in icons:
        pixbuf = Gtk.IconTheme.get_default().load_icon(icon, 64, 0)
        liststore.append([pixbuf, "Label"])

    self.add(iconview)

win = IconViewWindow()
win.connect("delete-event", Gtk.main_quit)
win.show_all()
Gtk.main()