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.
The column of the icon view model which is being used for displaying tooltips on it's rows.
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.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
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.
This function is only used by GtkWidget
subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Requests the user's screen reader to announce the given message.
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 the widget’s tooltip is about to be shown.
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 PangoContext
with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout
with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
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 accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
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.
Retrieves the accessible implementation for the given GtkAccessible
.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
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.
Gets the reading direction for a particular widget.
Get the GdkDisplay
for the toplevel window associated with this widget.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Returns the current focus child of @widget.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Retrieves the GtkAdjustment
used for horizontal scrolling.
Gets the horizontal GtkScrollablePolicy
.
Gets the column in which the item @path is currently displayed. Column numbers start at 0.
Gets the row in which the item @path is currently displayed. Row numbers start at 0.
Returns the widget’s last child.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
Gets a PangoContext
with the appropriate font map, font description, and base direction for this widget.
Gets the path for the icon at the given position.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
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().
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 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.
Retrieves the GtkAdjustment
used for vertical scrolling.
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.
Sets the parent and sibling of an accessible object.
Sets the GtkCellLayout
DataFunc to use for @cell_layout.
Sets whether @widget should be mapped along with its parent.
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.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Sets the horizontal adjustment of the GtkScrollable
.
Sets the GtkScrollablePolicy
.
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 sensitivity of a widget.
Sets the minimum size of a widget.
Turns on flag values in the current widget state.
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().
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 the vertical adjustment of the GtkScrollable
.
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.
Updates the next accessible sibling of @self.