IconView
GtkIconView is a widget which displays data in a grid of icons.
GtkIconView provides an alternative view on a GtkTreeModel. It displays the model as a grid of icons with labels. Like class@Gtk.TreeView, it allows to select one or multiple items (depending on the selection mode, see method@Gtk.IconView.set_selection_mode). In addition to selection with the arrow keys, GtkIconView 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), GtkIconView will only display the first level of the tree and ignore the tree’s branches.
CSS nodes
iconview.view
╰── [rubberband]GtkIconView has a single CSS node with name iconview and style class .view. For rubberband selection, a subnode with name rubberband is used.
Skipped during bindings generation
parameter
path: path: Out parameter is not supportedparameter
path: path: Out parameter is not supportedparameter
path: path: Out parameter is not supportedparameter
path: path: Out parameter is not supportedparameter
model: model: Out parameter is not supportedparameter
start_path: start_path: Out parameter is not supportedmethod
cell-area: Property has no getter nor setter
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click.
The column-spacing property specifies the space which is inserted between the columns of the icon view.
A list of css classes applied to this widget.
Whether the widget should grab focus when it is clicked with the mouse.
Horizontal GtkAdjustment of the scrollable widget.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
Determines when horizontal scrolling should start.
The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other.
The item-padding property specifies the padding around each of the icon view's item.
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
The ::markup-column property contains the number of the model column containing markup information to be displayed. The markup column must be of type G_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.
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.
Whether the widget will receive the default action when it is focused.
The reorderable property specifies if the items can be reordered by DND.
The row-spacing property specifies the space which is inserted between the rows of the icon view.
The scale factor of the widget.
The ::selection-mode property specifies the selection mode of icon view. If the mode is %GTK_SELECTION_MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible.
The ::text-column property contains the number of the model column containing the texts which are displayed. The text column must be of type G_TYPE_STRING. If this property and the :markup-column property are both set to -1, no texts are displayed.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
Vertical GtkAdjustment of the scrollable widget.
Whether to use the vexpand property.
Determines when vertical scrolling should start.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
Adds an attribute mapping to the list in @cell_layout.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
Called by widgets as the user moves around the window using keyboard shortcuts.
Clears all existing attributes previously set with gtk_cell_layout_set_attributes().
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
A class@Gtk.SignalAction which gets emitted when the user activates the currently focused item.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when @widget is hidden.
The ::item-activated signal is emitted when the method gtk_icon_view_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.
Emitted if keyboard navigation fails.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
The ::move-cursor signal is a class@Gtk.SignalAction which gets emitted when the user initiates a cursor movement.
Emitted when the focus is moved.
Emitted when @widget is associated with a GdkSurface.
A class@Gtk.SignalAction which gets emitted when the user selects all items.
A class@Gtk.SignalAction which gets emitted when the user selects the item that is currently focused.
The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes.
Emitted when @widget is shown.
Emitted when the widget state changes.
A class@Gtk.SignalAction 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.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
A class@Gtk.SignalAction which gets emitted when the user unselects all items.
Creates a GdkPaintable representation of the item at @path. This image is used for a drag icon.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Turns @icon_view into a drop destination for automatic DND. Calling this method sets GtkIconView:reorderable to false.
Turns @icon_view into a drag source for automatic DND. Calling this method sets GtkIconView:reorderable to false.
Retrieves the GtkAccessibleRole for the given GtkAccessible.
Gets the setting set by gtk_icon_view_set_activate_on_single_click().
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Gets the ID of the @buildable object.
Determines whether the input focus can enter @widget or any of its children.
Queries whether @widget can be the target of pointer events.
Fills the bounding rectangle in widget coordinates for the cell specified by
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Returns the value of the ::columns property.
Returns the value of the ::column-spacing property.
Returns the list of style classes applied to @widget.
Returns the CSS name that is used for @self.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Returns the widgets first child.
Determines whether @widget can own the input focus.
Returns the current focus child of @widget.
Returns whether the widget should grab focus when it is clicked with the mouse.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Retrieves the GtkAdjustment used for horizontal scrolling.
Returns the current value of the has-tooltip property.
Gets whether the widget would like any available extra horizontal space.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
Gets the horizontal GtkScrollablePolicy.
Gets the column in which the item @path is currently displayed. Column numbers start at 0.
Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.
Returns the value of the ::item-padding property.
Gets the row in which the item @path is currently displayed. Row numbers start at 0.
Returns the value of the ::item-width property.
Returns the widgets last child.
Retrieves the layout manager used by @widget.
Gets the bottom margin of @widget.
Gets the end margin of @widget.
Gets the start margin of @widget.
Gets the top margin of @widget.
Returns the column with markup text for @icon_view.
Returns the widgets next sibling.
#Fetches the requested opacity for this widget.
Returns the widgets overflow value.
Gets the path for the icon at the given position.
Returns the column with pixbufs for @icon_view.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widgets previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
Retrieves whether the user can reorder the list via drag-and-drop. See gtk_icon_view_set_reorderable().
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Returns the value of the ::row-spacing property.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
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 GtkTreeRowReferences. To do this, you can use gtk_tree_row_reference_new().
Gets the selection mode of the @icon_view.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the value of the ::spacing property.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Returns the column with text for @icon_view.
Returns the column of @icon_view’s model which is being used for displaying tooltips on @icon_view’s rows.
Gets the contents of the tooltip for @widget.
Gets the contents of the tooltip for @widget.
Retrieves the GtkAdjustment used for vertical scrolling.
Gets whether the widget would like any available extra vertical space.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
Determines whether the widget is visible.
Gets the vertical GtkScrollablePolicy.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Returns the widget’s effective sensitivity.
Activates the item determined by @path.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Adds the @cell to the end of @cell_layout. If @expand is false, then the
Packs the @cell into the beginning of @cell_layout. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true.
Returns true if the icon pointed to by @path is currently selected. If @path does not point to a valid location, false is returned.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Re-inserts @cell at @position.
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Moves the alignments of @icon_view to the position specified by @path.
Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function.
Selects the row at @path.
Causes the GtkIconView::item-activated signal to be emitted on a single click instead of a double click.
Specifies whether the input focus can enter the widget or any of its children.
Sets whether @widget can be the target of pointer events.
Sets the GtkCellLayoutDataFunc to use for @cell_layout.
Sets whether @widget should be mapped along with its parent.
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.
Sets the ::column-spacing property which specifies the space which is inserted between the columns of the icon view.
Clear all style classes applied to @widget and replace them with @classes.
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 null, 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.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the reading direction on a particular widget.
Sets the item that is highlighted for feedback.
Specifies whether @widget can own the input focus.
Set @child as the current focus child of @widget.
Sets whether the widget should grab focus when it is clicked with the mouse.
Sets the font map to use for Pango rendering.
Sets the horizontal adjustment of the GtkScrollable.
Sets the has-tooltip property on @widget to @has_tooltip.
Sets whether the widget would like any available extra horizontal space.
Sets whether the hexpand flag will be used.
Sets the GtkScrollablePolicy.
Sets the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.
Sets the GtkIconView:item-padding property which specifies the padding around each of the icon view’s items.
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.
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.
Sets the bottom margin of @widget.
Sets the end margin of @widget.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
Sets the start margin of @widget.
Sets the top margin of @widget.
Sets the column with markup information for @icon_view to be
Request the @widget to be rendered partially transparent.
Sets how @widget treats content that is drawn outside the widget's content area.
Sets the column with pixbufs for @icon_view to be @column. The pixbuf column must be of type GDK_TYPE_PIXBUF
Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface. Both GtkTreeStore and GtkListStore 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.
Sets the ::row-spacing property which specifies the space which is inserted between the rows of the icon view.
Sets the selection mode of the @icon_view.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Sets the ::spacing property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.
Turns on flag values in the current widget state.
Sets the column with text for @icon_view to be @column. The text column must be of type G_TYPE_STRING.
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().
If you only plan to have simple (text-only) tooltips on full items, you can use this function to have GtkIconView handle these automatically for you. @column should be set to the column in @icon_view’s model containing the tooltip texts, or -1 to disable this feature.
Sets the tip area of @tooltip to be the area covered by the item at @path. See also gtk_icon_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area().
Sets @markup as the contents of the tooltip, which is marked up with Pango markup.
Sets @text as the contents of the tooltip.
Sets the vertical adjustment of the GtkScrollable.
Sets whether the widget would like any available extra vertical space.
Sets whether the vexpand flag will be used.
Sets the visibility state of @widget.
Sets the GtkScrollablePolicy.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Unselects all the icons.
Unselects the row at @path.
Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this method sets GtkIconView:reorderable to false.
Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this method sets GtkIconView:reorderable to false.
Turns off flag values for the current widget state.