Gtk.IconView¶

Example¶

Subclasses:	None

Methods¶

Inherited:	Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.CellLayout (9), Gtk.Scrollable (9)
Structs:	Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` ()
class	`new_with_area` (area)
class	`new_with_model` (model)
	`convert_widget_to_bin_window_coords` (wx, wy)
	`create_drag_icon` (path)
	`enable_model_drag_dest` (targets, actions)
	`enable_model_drag_source` (start_button_mask, targets, actions)
	`get_activate_on_single_click` ()
	`get_cell_rect` (path, cell)
	`get_column_spacing` ()
	`get_columns` ()
	`get_cursor` ()
	`get_dest_item_at_pos` (drag_x, drag_y)
	`get_drag_dest_item` ()
	`get_item_at_pos` (x, y)
	`get_item_column` (path)
	`get_item_orientation` ()
	`get_item_padding` ()
	`get_item_row` (path)
	`get_item_width` ()
	`get_margin` ()
	`get_markup_column` ()
	`get_model` ()
	`get_path_at_pos` (x, y)
	`get_pixbuf_column` ()
	`get_reorderable` ()
	`get_row_spacing` ()
	`get_selected_items` ()
	`get_selection_mode` ()
	`get_spacing` ()
	`get_text_column` ()
	`get_tooltip_column` ()
	`get_tooltip_context` (x, y, keyboard_tip)
	`get_visible_range` ()
	`item_activated` (path)
	`path_is_selected` (path)
	`scroll_to_path` (path, use_align, row_align, col_align)
	`select_all` ()
	`select_path` (path)
	`selected_foreach` (func, *data)
	`set_activate_on_single_click` (single)
	`set_column_spacing` (column_spacing)
	`set_columns` (columns)
	`set_cursor` (path, cell, start_editing)
	`set_drag_dest_item` (path, pos)
	`set_item_orientation` (orientation)
	`set_item_padding` (item_padding)
	`set_item_width` (item_width)
	`set_margin` (margin)
	`set_markup_column` (column)
	`set_model` (model)
	`set_pixbuf_column` (column)
	`set_reorderable` (reorderable)
	`set_row_spacing` (row_spacing)
	`set_selection_mode` (mode)
	`set_spacing` (spacing)
	`set_text_column` (column)
	`set_tooltip_cell` (tooltip, path, cell)
	`set_tooltip_column` (column)
	`set_tooltip_item` (tooltip, path)
	`unselect_all` ()
	`unselect_path` (path)
	`unset_model_drag_dest` ()
	`unset_model_drag_source` ()

Virtual Methods¶

Inherited:	Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.CellLayout (9), Gtk.Scrollable (1)

	`do_activate_cursor_item` ()
	`do_item_activated` (path)
	`do_move_cursor` (step, count)
	`do_select_all` ()
	`do_select_cursor_item` ()
	`do_selection_changed` ()
	`do_toggle_cursor_item` ()
	`do_unselect_all` ()

Properties¶

Inherited:	Gtk.Container (3), Gtk.Widget (39), Gtk.Scrollable (4)

Name	Type	Flags	Short Description
`activate-on-single-click`	`bool`	r/w/en	Activate row on a single click
`cell-area`	`Gtk.CellArea`	r/w/co	The `Gtk.CellArea` used to layout cells
`column-spacing`	`int`	r/w/en	Space which is inserted between grid columns
`columns`	`int`	r/w/en	Number of columns to display
`item-orientation`	`Gtk.Orientation`	r/w/en	How the text and icon of each item are positioned relative to each other
`item-padding`	`int`	r/w/en	Padding around icon view items
`item-width`	`int`	r/w/en	The width used for each item
`markup-column`	`int`	r/w/en	Model column used to retrieve the text if using Pango markup
`model`	`Gtk.TreeModel`	r/w	The model for the icon view
`pixbuf-column`	`int`	r/w/en	Model column used to retrieve the icon pixbuf from
`reorderable`	`bool`	r/w/en	View is reorderable
`row-spacing`	`int`	r/w/en	Space which is inserted between grid rows
`selection-mode`	`Gtk.SelectionMode`	r/w/en	The selection mode
`spacing`	`int`	r/w/en	Space which is inserted between cells of an item
`text-column`	`int`	r/w/en	Model column used to retrieve the text from
`tooltip-column`	`int`	r/w/en	The column in the model containing the tooltip texts for the items

Style Properties¶

Inherited:	Gtk.Widget (17)

Name	Type	Default	Flags	Short Description
`selection-box-alpha`		`b'@'`	d/r	Opacity of the selection box `deprecated`
`selection-box-color`	`Gdk.Color`	`None`	d/r	Color of the selection box `deprecated`

Signals¶

Inherited:	Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`activate-cursor-item`	A `keybinding signal` which gets emitted when the user activates the currently focused item.
`item-activated`	The `::item-activated` signal is emitted when the method `Gtk.IconView.item_activated`() is called, when the user double clicks an item with the “activate-on-single-click” property set to `False`, or when the user single clicks an item when the “activate-on-single-click” property set to `True`.
`move-cursor`	The `::move-cursor` signal is a `keybinding signal` which gets emitted when the user initiates a cursor movement.
`select-all`	A `keybinding signal` which gets emitted when the user selects all items.
`select-cursor-item`	A `keybinding signal` which gets emitted when the user selects the item that is currently focused.
`selection-changed`	The `::selection-changed` signal is emitted when the selection (i.e.
`toggle-cursor-item`	A `keybinding signal` which gets emitted when the user toggles whether the currently focused item is selected or not.
`unselect-all`	A `keybinding signal` which gets emitted when the user unselects all items.

Fields¶

Inherited:	Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent	`Gtk.Container`	r

Class Details¶

class Gtk.IconView(*args, **kwargs)¶

Bases:	`Gtk.Container`, `Gtk.CellLayout`, `Gtk.Scrollable`
Abstract:	No
Structure:	`Gtk.IconViewClass`

Gtk.IconView provides an alternative view on a Gtk.TreeModel. It displays the model as a grid of icons with labels. Like Gtk.TreeView, it allows to select one or multiple items (depending on the selection mode, see Gtk.IconView.set_selection_mode()). In addition to selection with the arrow keys, Gtk.IconView supports rubberband selection, which is controlled by dragging the pointer.

Note that if the tree model is backed by an actual tree store (as opposed to a flat list where the mapping to icons is obvious), Gtk.IconView will only display the first level of the tree and ignore the tree’s branches.

CSS nodes

iconview.view
╰── [rubberband]

Gtk.IconView has a single CSS node with name iconview and style class .view. For rubberband selection, a subnode with name rubberband is used.

classmethod new()[source]¶

Returns:	A newly created `Gtk.IconView` widget
Return type:	`Gtk.Widget`

Creates a new Gtk.IconView widget

New in version 2.6.

classmethod new_with_area(area)[source]¶

Parameters:	area (`Gtk.CellArea`) – the `Gtk.CellArea` to use to layout cells
Returns:	A newly created `Gtk.IconView` widget
Return type:	`Gtk.Widget`

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

New in version 3.0.

classmethod new_with_model(model)[source]¶

Parameters:	model (`Gtk.TreeModel`) – The model.
Returns:	A newly created `Gtk.IconView` widget.
Return type:	`Gtk.Widget`

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

New in version 2.6.

convert_widget_to_bin_window_coords(wx, wy)[source]¶

Parameters:

wx (int) – X coordinate relative to the widget
wy (int) – Y coordinate relative to the widget

Returns:

bx:	return location for bin_window X coordinate
by:	return location for bin_window Y coordinate

Return type:

(bx: int, by: int)

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

New in version 2.12.

create_drag_icon(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – a `Gtk.TreePath` in self
Returns:	a newly-allocated surface of the drag icon.
Return type:	`cairo.Surface`

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

New in version 2.8.

enable_model_drag_dest(targets, actions)[source]¶

Parameters:	targets ([`Gtk.TargetEntry`]) – the table of targets that the drag will support actions (`Gdk.DragAction`) – the bitmask of possible actions for a drag to this widget

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

New in version 2.8.

enable_model_drag_source(start_button_mask, targets, actions)[source]¶

Parameters:	start_button_mask (`Gdk.ModifierType`) – Mask of allowed buttons to start drag targets ([`Gtk.TargetEntry`]) – the table of targets that the drag will support actions (`Gdk.DragAction`) – the bitmask of possible actions for a drag from this widget

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

New in version 2.8.

get_activate_on_single_click()[source]¶

Returns:	`True` if item-activated will be emitted on a single click
Return type:	`bool`

Gets the setting set by Gtk.IconView.set_activate_on_single_click().

New in version 3.8.

get_cell_rect(path, cell)[source]¶

Parameters:

path (Gtk.TreePath) – a Gtk.TreePath
cell (Gtk.CellRenderer or None) – a Gtk.CellRenderer or None

Returns:

False if there is no such item, True otherwise

rect:	rectangle to fill with cell rect

Return type:

(bool, rect: Gdk.Rectangle)

Fills the bounding rectangle in widget coordinates for the cell specified by path and cell. If cell is None the main cell area is used.

This function is only valid if self is realized.

New in version 3.6.

get_column_spacing()[source]¶

Returns:	the space between columns
Return type:	`int`

Returns the value of the ::column-spacing property.

New in version 2.6.

get_columns()[source]¶

Returns:	the number of columns, or -1
Return type:	`int`

Returns the value of the ::columns property.

New in version 2.6.

get_cursor()[source]¶

Returns:

True if the cursor is set.

path:	Return location for the current cursor path, or `None`
cell:	Return location the current focus cell, or `None`

Return type: (bool, path: Gtk.TreePath, cell: Gtk.CellRenderer)

Fills in path and cell with 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.

The returned Gtk.TreePath must be freed with Gtk.TreePath.free().

New in version 2.8.

get_dest_item_at_pos(drag_x, drag_y)[source]¶

Parameters:

drag_x (int) – the position to determine the destination item for
drag_y (int) – the position to determine the destination item for

Returns:

If there is no item at the given position return None otherwise a tuple containing:

path:	The path of the item
pos:	The drop position

Return type:

(path: Gtk.TreePath, pos: Gtk.IconViewDropPosition) or None

Determines the destination item for a given position.

New in version 2.8.

get_drag_dest_item()[source]¶

Returns:

path:	Return location for the path of the highlighted item, or `None`.
pos:	Return location for the drop position, or `None`

Return type: (path: Gtk.TreePath, pos: Gtk.IconViewDropPosition)

Gets information about the item that is highlighted for feedback.

New in version 2.8.

get_item_at_pos(x, y)[source]¶

Parameters:

x (int) – The x position to be identified
y (int) – The y position to be identified

Returns:

If not item exists at the specified position returns None, otherwise a tuple containing:

path:	The path
cell:	The renderer responsible for the cell at (x, y)

Return type:

(path: Gtk.TreePath, cell: Gtk.CellRenderer) or None

Finds the path at the point (x, y), relative to bin_window coordinates. In contrast to Gtk.IconView.get_path_at_pos(), this function also obtains the cell at the specified position. The returned path should be freed with Gtk.TreePath.free(). See Gtk.IconView.convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates.

New in version 2.8.

get_item_column(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – the `Gtk.TreePath` of the item
Returns:	The column in which the item is displayed
Return type:	`int`

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

New in version 2.22.

get_item_orientation()[source]¶

Returns:	the relative position of texts and icons
Return type:	`Gtk.Orientation`

Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.

New in version 2.6.

get_item_padding()[source]¶

Returns:	the padding around items
Return type:	`int`

Returns the value of the ::item-padding property.

New in version 2.18.

get_item_row(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – the `Gtk.TreePath` of the item
Returns:	The row in which the item is displayed
Return type:	`int`

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

New in version 2.22.

get_item_width()[source]¶

Returns:	the width of a single item, or -1
Return type:	`int`

Returns the value of the ::item-width property.

New in version 2.6.

get_margin()[source]¶

Returns:	the space at the borders
Return type:	`int`

Returns the value of the ::margin property.

New in version 2.6.

get_markup_column()[source]¶

Returns:	the markup column, or -1 if it’s unset.
Return type:	`int`

Returns the column with markup text for self.

New in version 2.6.

get_model()[source]¶

Returns:	A `Gtk.TreeModel`, or `None` if none is currently being used.
Return type:	`Gtk.TreeModel` or `None`

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

New in version 2.6.

get_path_at_pos(x, y)[source]¶

Parameters:	x (`int`) – The x position to be identified y (`int`) – The y position to be identified
Returns:	The `Gtk.TreePath` corresponding to the icon or `None` if no icon exists at that position.
Return type:	`Gtk.TreePath` or `None`

Finds the path at the point (x, y), relative to bin_window coordinates. See Gtk.IconView.get_item_at_pos(), if you are also interested in the cell at the specified position. See Gtk.IconView.convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates.

New in version 2.6.

get_pixbuf_column()[source]¶

Returns:	the pixbuf column, or -1 if it’s unset.
Return type:	`int`

Returns the column with pixbufs for self.

New in version 2.6.

get_reorderable()[source]¶

Returns:	`True` if the list can be reordered.
Return type:	`bool`

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

New in version 2.8.

get_row_spacing()[source]¶

Returns:	the space between rows
Return type:	`int`

Returns the value of the ::row-spacing property.

New in version 2.6.

get_selected_items()[source]¶

Returns:	A `GLib.List` containing a `Gtk.TreePath` for each selected row.
Return type:	[`Gtk.TreePath`]

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.TreeRowReferences. To do this, you can use Gtk.TreeRowReference.new().

To free the return value, use:

g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);

New in version 2.6.

get_selection_mode()[source]¶

Returns:	the current selection mode
Return type:	`Gtk.SelectionMode`

Gets the selection mode of the self.

New in version 2.6.

get_spacing()[source]¶

Returns:	the space between cells
Return type:	`int`

Returns the value of the ::spacing property.

New in version 2.6.

get_text_column()[source]¶

Returns:	the text column, or -1 if it’s unset.
Return type:	`int`

Returns the column with text for self.

New in version 2.6.

get_tooltip_column()[source]¶

Returns:	the index of the tooltip column that is currently being used, or -1 if this is disabled.
Return type:	`int`

Returns the column of self’s model which is being used for displaying tooltips on self’s rows.

New in version 2.12.

get_tooltip_context(x, y, keyboard_tip)[source]¶

Parameters:

x (int) – the x coordinate (relative to widget coordinates)
y (int) – the y coordinate (relative to widget coordinates)
keyboard_tip (bool) – whether this is a keyboard tooltip or not

Returns:

whether or not the given tooltip context points to a item

x:	the x coordinate (relative to widget coordinates)
y:	the y coordinate (relative to widget coordinates)
model:	a pointer to receive a `Gtk.TreeModel` or `None`
path:	a pointer to receive a `Gtk.TreePath` or `None`
iter:	a pointer to receive a `Gtk.TreeIter` or `None`

Return type:

(bool, x: int, y: int, model: Gtk.TreeModel, path: Gtk.TreePath, iter: Gtk.TreeIter)

This function is supposed to be used in a Gtk.Widget ::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 function 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 any of model, path and iter which have been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to self’s bin_window if keyboard_tooltip is False.

New in version 2.12.

get_visible_range()[source]¶

Returns:

Returns None if there is no visible range or a tuple containing:

start_path:	Start of region
end_path:	End of region

Return type: (start_path: Gtk.TreePath, end_path: Gtk.TreePath) or None

Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.

Both paths should be freed with Gtk.TreePath.free() after use.

New in version 2.8.

item_activated(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – The `Gtk.TreePath` to be activated

Activates the item determined by path.

New in version 2.6.

path_is_selected(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – A `Gtk.TreePath` to check selection on.
Returns:	`True` if path is selected.
Return type:	`bool`

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

New in version 2.6.

scroll_to_path(path, use_align, row_align, col_align)[source]¶

Parameters:	path (`Gtk.TreePath`) – The path of the item to move to. use_align (`bool`) – whether to use alignment arguments, or `False`. row_align (`float`) – The vertical alignment of the item specified by path. col_align (`float`) – The horizontal alignment of the item specified by path.

Moves the alignments of self to the position specified by path. row_align determines where the row is placed, and 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, then 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 self is realized, the centered path will be modified to reflect this change.

New in version 2.8.

select_all()[source]¶: Selects all the icons. self must has its selection mode set to Gtk.SelectionMode.MULTIPLE.

New in version 2.6.

select_path(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – The `Gtk.TreePath` to be selected.

Selects the row at path.

New in version 2.6.

selected_foreach(func, *data)[source]¶

Parameters:	func (`Gtk.IconViewForeachFunc`) – The function to call for each selected icon. data (`object` or `None`) – User data to pass to the function.

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

New in version 2.6.

set_activate_on_single_click(single)[source]¶

Parameters:	single (`bool`) – `True` to emit item-activated on a single click

Causes the Gtk.IconView ::item-activated signal to be emitted on a single click instead of a double click.

New in version 3.8.

set_column_spacing(column_spacing)[source]¶

Parameters:	column_spacing (`int`) – the column spacing

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

New in version 2.6.

set_columns(columns)[source]¶

Parameters:	columns (`int`) – the number of 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.

New in version 2.6.

set_cursor(path, cell, start_editing)[source]¶

Parameters:	path (`Gtk.TreePath`) – A `Gtk.TreePath` cell (`Gtk.CellRenderer` or `None`) – One of the cell renderers of self, or `None` start_editing (`bool`) – `True` if the specified cell should start being edited.

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 gtk_widget_grab_focus (icon_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

New in version 2.8.

set_drag_dest_item(path, pos)[source]¶

Parameters:	path (`Gtk.TreePath` or `None`) – The path of the item to highlight, or `None`. pos (`Gtk.IconViewDropPosition`) – Specifies where to drop, relative to the item

Sets the item that is highlighted for feedback.

New in version 2.8.

set_item_orientation(orientation)[source]¶

Parameters:	orientation (`Gtk.Orientation`) – the relative position of texts and icons

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

New in version 2.6.

set_item_padding(item_padding)[source]¶

Parameters:	item_padding (`int`) – the item padding

Sets the Gtk.IconView :item-padding property which specifies the padding around each of the icon view’s items.

New in version 2.18.

set_item_width(item_width)[source]¶

Parameters:	item_width (`int`) – the width for each item

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.

New in version 2.6.

set_margin(margin)[source]¶

Parameters:	margin (`int`) – the margin

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

New in version 2.6.

set_markup_column(column)[source]¶

Parameters:	column (`int`) – A column in the currently used model, or -1 to display no text

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

New in version 2.6.

set_model(model)[source]¶

Parameters:	model (`Gtk.TreeModel` or `None`) – The model.

Sets the model for a Gtk.IconView. If the self 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.

New in version 2.6.

set_pixbuf_column(column)[source]¶

Parameters:	column (`int`) – A column in the currently used model, or -1 to disable

Sets the column with pixbufs for self to be column. The pixbuf column must be of type #GDK_TYPE_PIXBUF

New in version 2.6.

set_reorderable(reorderable)[source]¶

Parameters:	reorderable (`bool`) – `True`, if the list of items can be reordered.

This function is a convenience function to allow you to reorder models that support the Gtk.TreeDragSourceIface and the Gtk.TreeDragDestIface. 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 to the model’s row_inserted and row_deleted signals. The reordering is implemented by setting up the icon view as a 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.

New in version 2.8.

set_row_spacing(row_spacing)[source]¶

Parameters:	row_spacing (`int`) – the row spacing

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

New in version 2.6.

set_selection_mode(mode)[source]¶

Parameters:	mode (`Gtk.SelectionMode`) – The selection mode

Sets the selection mode of the self.

New in version 2.6.

set_spacing(spacing)[source]¶

Parameters:	spacing (`int`) – the 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.

New in version 2.6.

set_text_column(column)[source]¶

Parameters:	column (`int`) – A column in the currently used model, or -1 to display no text

Sets the column with text for self to be column. The text column must be of type GObject.TYPE_STRING.

New in version 2.6.

set_tooltip_cell(tooltip, path, cell)[source]¶

Parameters:	tooltip (`Gtk.Tooltip`) – a `Gtk.Tooltip` path (`Gtk.TreePath`) – a `Gtk.TreePath` cell (`Gtk.CellRenderer` or `None`) – a `Gtk.CellRenderer` or `None`

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 Gtk.IconView.set_tooltip_column() for a simpler alternative.

New in version 2.12.

set_tooltip_column(column)[source]¶

Parameters:	column (`int`) – an integer, which is a valid column number for self’s model

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 self’s model containing the tooltip texts, or -1 to disable this feature.

When enabled, Gtk.Widget :has-tooltip will be set to True and self will connect a Gtk.Widget ::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.

New in version 2.12.

set_tooltip_item(tooltip, path)[source]¶

Parameters:	tooltip (`Gtk.Tooltip`) – a `Gtk.Tooltip` path (`Gtk.TreePath`) – a `Gtk.TreePath`

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

New in version 2.12.

unselect_all()[source]¶: Unselects all the icons.

New in version 2.6.

unselect_path(path)[source]¶

Parameters:	path (`Gtk.TreePath`) – The `Gtk.TreePath` to be unselected.

Unselects the row at path.

New in version 2.6.

unset_model_drag_dest()[source]¶: Undoes the effect of Gtk.IconView.enable_model_drag_dest(). Calling this method sets Gtk.IconView :reorderable to False.

New in version 2.8.

unset_model_drag_source()[source]¶: Undoes the effect of Gtk.IconView.enable_model_drag_source(). Calling this method sets Gtk.IconView :reorderable to False.

New in version 2.8.

do_activate_cursor_item() virtual¶

Return type:	`bool`

do_item_activated(path) virtual¶

Parameters:	path (`Gtk.TreePath`) – The `Gtk.TreePath` to be activated

Activates the item determined by path.

New in version 2.6.

do_move_cursor(step, count) virtual¶

Parameters:	step (`Gtk.MovementStep`) – count (`int`) –
Return type:	`bool`

do_select_all() virtual¶: Selects all the icons. icon_view must has its selection mode set to Gtk.SelectionMode.MULTIPLE.

New in version 2.6.

do_select_cursor_item() virtual¶

do_selection_changed() virtual¶

do_toggle_cursor_item() virtual¶

do_unselect_all() virtual¶: Unselects all the icons.

New in version 2.6.

Signal Details¶

Gtk.IconView.signals.activate_cursor_item(icon_view)¶

Signal Name:	`activate-cursor-item`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal
Return type:	`bool`

A keybinding signal which gets emitted when the user activates the currently focused item.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control activation programmatically.

The default bindings for this signal are Space, Return and Enter.

Gtk.IconView.signals.item_activated(icon_view, path)¶

Signal Name:	`item-activated`
Flags:	`RUN_LAST`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal path (`Gtk.TreePath`) – the `Gtk.TreePath` for the activated item

The ::item-activated signal is emitted when the method Gtk.IconView.item_activated() is called, when the user double clicks an item with the “activate-on-single-click” property set to False, or when the user single clicks an item when the “activate-on-single-click” property set to True. It is also emitted when a non-editable item is selected and one of the keys: Space, Return or Enter is pressed.

Gtk.IconView.signals.move_cursor(icon_view, step, count)¶

Signal Name:	`move-cursor`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal step (`Gtk.MovementStep`) – the granularity of the move, as a `Gtk.MovementStep` count (`int`) – the number of step units to move
Return type:	`bool`

The ::move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal include

Arrow keys which move by individual steps
Home/End keys which move to the first/last item
PageUp/PageDown which move by “pages” All of these will extend the selection when combined with the Shift modifier.

Gtk.IconView.signals.select_all(icon_view)¶

Signal Name:	`select-all`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal

A keybinding signal which gets emitted when the user selects all items.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control selection programmatically.

The default binding for this signal is Ctrl-a.

Gtk.IconView.signals.select_cursor_item(icon_view)¶

Signal Name:	`select-cursor-item`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal

A keybinding signal which gets emitted when the user selects the item that is currently focused.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control selection programmatically.

There is no default binding for this signal.

Gtk.IconView.signals.selection_changed(icon_view)¶

Signal Name:	`selection-changed`
Flags:	`RUN_FIRST`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal

The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes.

Gtk.IconView.signals.toggle_cursor_item(icon_view)¶

Signal Name:	`toggle-cursor-item`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal

A keybinding signal which gets emitted when the user toggles whether the currently focused item is selected or not. The exact effect of this depend on the selection mode.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control selection programmatically.

There is no default binding for this signal is Ctrl-Space.

Gtk.IconView.signals.unselect_all(icon_view)¶

Signal Name:	`unselect-all`
Flags:	`RUN_LAST`, `ACTION`
Parameters:	icon_view (`Gtk.IconView`) – The object which received the signal

A keybinding signal which gets emitted when the user unselects all items.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control selection programmatically.

The default binding for this signal is Ctrl-Shift-a.

Property Details¶

Gtk.IconView.props.activate_on_single_click¶

Name:	`activate-on-single-click`
Type:	`bool`
Default Value:	`False`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The activate-on-single-click property specifies whether the “item-activated” signal will be emitted after a single click.

New in version 3.8.

Gtk.IconView.props.cell_area¶

Name:	`cell-area`
Type:	`Gtk.CellArea`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT_ONLY`

The Gtk.CellArea used to layout cell renderers for this view.

If no area is specified when creating the icon view with Gtk.IconView.new_with_area() a Gtk.CellAreaBox will be used.

New in version 3.0.

Gtk.IconView.props.column_spacing¶

Name:	`column-spacing`
Type:	`int`
Default Value:	`6`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

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

New in version 2.6.

Gtk.IconView.props.columns¶

Name:	`columns`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The columns property contains the number of the columns in which the items should be displayed. If it is -1, the number of columns will be chosen automatically to fill the available area.

New in version 2.6.

Gtk.IconView.props.item_orientation¶

Name:	`item-orientation`
Type:	`Gtk.Orientation`
Default Value:	`Gtk.Orientation.VERTICAL`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other.

New in version 2.6.

Gtk.IconView.props.item_padding¶

Name:	`item-padding`
Type:	`int`
Default Value:	`6`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The item-padding property specifies the padding around each of the icon view’s item.

New in version 2.18.

Gtk.IconView.props.item_width¶

Name:	`item-width`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

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

New in version 2.6.

Gtk.IconView.props.markup_column¶

Name:	`markup-column`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The ::markup-column property contains the number of the model column containing markup information to be displayed. The markup column must be of type GObject.TYPE_STRING. If this property and the :text-column property are both set to column numbers, it overrides the text column. If both are set to -1, no texts are displayed.

New in version 2.6.

Gtk.IconView.props.model¶

Name:	`model`
Type:	`Gtk.TreeModel`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`

The model for the icon view

Gtk.IconView.props.pixbuf_column¶

Name:	`pixbuf-column`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The ::pixbuf-column property contains the number of the model column containing the pixbufs which are displayed. The pixbuf column must be of type #GDK_TYPE_PIXBUF. Setting this property to -1 turns off the display of pixbufs.

New in version 2.6.

Gtk.IconView.props.reorderable¶

Name:	`reorderable`
Type:	`bool`
Default Value:	`False`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The reorderable property specifies if the items can be reordered by DND.

New in version 2.8.

Gtk.IconView.props.row_spacing¶

Name:	`row-spacing`
Type:	`int`
Default Value:	`6`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

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

New in version 2.6.

Gtk.IconView.props.selection_mode¶

Name:	`selection-mode`
Type:	`Gtk.SelectionMode`
Default Value:	`Gtk.SelectionMode.SINGLE`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The ::selection-mode property specifies the selection mode of icon view. If the mode is Gtk.SelectionMode.MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible.

New in version 2.6.

Gtk.IconView.props.spacing¶

Name:	`spacing`
Type:	`int`
Default Value:	`0`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

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

New in version 2.6.

Gtk.IconView.props.text_column¶

Name:	`text-column`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The ::text-column property contains the number of the model column containing the texts which are displayed. The text column must be of type GObject.TYPE_STRING. If this property and the :markup-column property are both set to -1, no texts are displayed.

New in version 2.6.

Gtk.IconView.props.tooltip_column¶

Name:	`tooltip-column`
Type:	`int`
Default Value:	`-1`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The column in the model containing the tooltip texts for the items