gtk4/org.gtkkn.bindings.gtk/IconView

IconView

open class IconView(pointer: <Error class: unknown class><<Error class: unknown class>>) : Widget, CellLayout, Scrollable

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 supported
parameter path: path: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter model: model: Out parameter is not supported
parameter start_path: start_path: Out parameter is not supported
method cell-area: Property has no getter nor setter

Constructors

IconView

constructor()

Creates a new GtkIconView widget

constructor(area: CellArea)

Creates a new GtkIconView widget using the specified @area to layout cells inside the icons.

constructor(model: TreeModel)

Creates a new GtkIconView widget with the model @model.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

accessibleRole

open val accessibleRole: AccessibleRole

The accessible role of the given GtkAccessible implementation.

activateOnSingleClick

open var activateOnSingleClick: Boolean

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

canFocus

open var canFocus: Boolean

Whether the widget or any of its descendents can accept the input focus.

canTarget

open var canTarget: Boolean

Whether the widget can receive pointer events.

columns

open var columns: Int

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.

columnSpacing

open var columnSpacing: Int

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

cssClasses

open var cssClasses: List<String>

A list of css classes applied to this widget.

cssName

open val cssName: String

The name of this widget in the CSS tree.

cursor

open var cursor: <Error class: unknown class>?

The cursor used by @widget.

focusable

open var focusable: Boolean

Whether this widget itself will accept the input focus.

focusOnClick

open var focusOnClick: Boolean

Whether the widget should grab focus when it is clicked with the mouse.

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkCellLayoutPointer

open override val gtkCellLayoutPointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

gtkIconViewPointer

val gtkIconViewPointer: <Error class: unknown class><<Error class: unknown class>>

gtkScrollablePointer

open override val gtkScrollablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkWidgetPointer

val gtkWidgetPointer: <Error class: unknown class><<Error class: unknown class>>

hadjustment

open var hadjustment: Adjustment?

Horizontal GtkAdjustment of the scrollable widget.

halign

open var halign: Align

How to distribute horizontal space if widget gets extra space.

hasTooltip

open var hasTooltip: Boolean

Enables or disables the emission of the ::query-tooltip signal on @widget.

hexpand

open var hexpand: Boolean

Whether to expand horizontally.

hexpandSet

open var hexpandSet: Boolean

Whether to use the hexpand property.

hscrollPolicy

open var hscrollPolicy: ScrollablePolicy

Determines when horizontal scrolling should start.

itemOrientation

open var itemOrientation: Orientation

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

itemPadding

open var itemPadding: Int

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

itemWidth

open var itemWidth: Int

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.

layoutManager

open var layoutManager: LayoutManager?

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

margin

open var margin: Int

The margin property specifies the space which is inserted at the edges of the icon view.

marginBottom

open var marginBottom: Int

Margin on bottom side of widget.

marginEnd

open var marginEnd: Int

Margin on end of widget, horizontally.

marginStart

open var marginStart: Int

Margin on start of widget, horizontally.

marginTop

open var marginTop: Int

Margin on top side of widget.

markupColumn

open var markupColumn: Int

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.

model

open var model: TreeModel?

The model of the icon view.

name

open var name: String

The name of the widget.

opacity

open var opacity: Double

The requested opacity of the widget.

overflow

open var overflow: Overflow

How content outside the widget's content area is treated.

parent

open val parent: Widget?

The parent widget of this widget.

pixbufColumn

open var pixbufColumn: Int

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.

receivesDefault

open var receivesDefault: Boolean

Whether the widget will receive the default action when it is focused.

reorderable

open var reorderable: Boolean

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

root

open val root: Root?

The GtkRoot widget of the widget tree containing this widget.

rowSpacing

open var rowSpacing: Int

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

scaleFactor

open val scaleFactor: Int

The scale factor of the widget.

selectionMode

open var selectionMode: SelectionMode

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.

spacing

open var spacing: Int

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

textColumn

open var textColumn: Int

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.

tooltipColumn

open var tooltipColumn: Int

The column of the icon view model which is being used for displaying tooltips on it's rows.

tooltipMarkup

open var tooltipMarkup: String?

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

tooltipText

open var tooltipText: String?

Sets the text of tooltip to be the given string.

vadjustment

open var vadjustment: Adjustment?

Vertical GtkAdjustment of the scrollable widget.

valign

open var valign: Align

How to distribute vertical space if widget gets extra space.

vexpand

open var vexpand: Boolean

Whether to expand vertically.

vexpandSet

open var vexpandSet: Boolean

Whether to use the vexpand property.

vscrollPolicy

open var vscrollPolicy: ScrollablePolicy

Determines when vertical scrolling should start.

Functions

actionSetEnabled

open fun actionSetEnabled(actionName: String, enabled: Boolean)

Enable or disable an action installed with gtk_widget_class_install_action().

activate

open fun activate(): Boolean

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

activateAction

open fun activateAction(name: String, args: <Error class: unknown class>? = null): Boolean

Looks up the action in the action groups associated with

activateDefault

open fun activateDefault()

Activates the default.activate action from @widget.

addAttribute

open fun addAttribute(cell: CellRenderer, attribute: String, column: Int)

Adds an attribute mapping to the list in @cell_layout.

addController

open fun addController(controller: EventController)

Adds @controller to @widget so that it will receive events.

addCssClass

open fun addCssClass(cssClass: String)

Adds a style class to @widget.

addMnemonicLabel

open fun addMnemonicLabel(label: Widget)

Adds a widget to the list of mnemonic labels for this widget.

addTickCallback

open fun addTickCallback(callback: TickCallback): <Error class: unknown class>

Queues an animation frame update and adds a callback to be called before each frame.

allocate

open fun allocate(width: Int, height: Int, baseline: Int, transform: <Error class: unknown class>? = null)

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

announce

open fun announce(message: String, priority: AccessibleAnnouncementPriority)

Requests the user's screen reader to announce the given message.

childFocus

open fun childFocus(direction: DirectionType): Boolean

Called by widgets as the user moves around the window using keyboard shortcuts.

clear

open fun clear()

Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout.

clearAttributes

open fun clearAttributes(cell: CellRenderer)

Clears all existing attributes previously set with gtk_cell_layout_set_attributes().

computeBounds

open fun computeBounds(target: Widget, outBounds: <Error class: unknown class>): Boolean

Computes the bounds for @widget in the coordinate space of @target.

computeExpand

open fun computeExpand(orientation: Orientation): Boolean

Computes whether a container should give this widget extra space when possible.

computePoint

open fun computePoint(target: Widget, point: <Error class: unknown class>, outPoint: <Error class: unknown class>): Boolean

Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.

computeTransform

open fun computeTransform(target: Widget, outTransform: <Error class: unknown class>): Boolean

Computes a matrix suitable to describe a transformation from

connectActivateCursorItem

fun connectActivateCursorItem(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

A class@Gtk.SignalAction which gets emitted when the user activates the currently focused item.

connectDestroy

fun connectDestroy(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Signals that all holders of a reference to the widget should release the reference that they hold.

connectDirectionChanged

fun connectDirectionChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (previousDirection: TextDirection) -> Unit): <Error class: unknown class>

Emitted when the text direction of a widget changes.

connectHide

fun connectHide(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is hidden.

connectItemActivated

fun connectItemActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath) -> Unit): <Error class: unknown class>

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.

connectKeynavFailed

fun connectKeynavFailed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Boolean): <Error class: unknown class>

Emitted if keyboard navigation fails.

connectMap

fun connectMap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be mapped.

connectMnemonicActivate

fun connectMnemonicActivate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (groupCycling: Boolean) -> Boolean): <Error class: unknown class>

Emitted when a widget is activated via a mnemonic.

connectMoveCursor

fun connectMoveCursor(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (step: MovementStep, count: Int, extend: Boolean, modify: Boolean) -> Boolean): <Error class: unknown class>

The ::move-cursor signal is a class@Gtk.SignalAction which gets emitted when the user initiates a cursor movement.

connectMoveFocus

fun connectMoveFocus(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Unit): <Error class: unknown class>

Emitted when the focus is moved.

connectQueryTooltip

fun connectQueryTooltip(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (x: Int, y: Int, keyboardMode: Boolean, tooltip: Tooltip) -> Boolean): <Error class: unknown class>

Emitted when the widget’s tooltip is about to be shown.

connectRealize

fun connectRealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is associated with a GdkSurface.

connectSelectAll

fun connectSelectAll(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

A class@Gtk.SignalAction which gets emitted when the user selects all items.

connectSelectCursorItem

fun connectSelectCursorItem(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

A class@Gtk.SignalAction which gets emitted when the user selects the item that is currently focused.

connectSelectionChanged

fun connectSelectionChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

connectShow

fun connectShow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is shown.

connectStateFlagsChanged

fun connectStateFlagsChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (flags: StateFlags) -> Unit): <Error class: unknown class>

Emitted when the widget state changes.

connectToggleCursorItem

fun connectToggleCursorItem(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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.

connectUnmap

fun connectUnmap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be unmapped.

connectUnrealize

fun connectUnrealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the GdkSurface associated with @widget is destroyed.

connectUnselectAll

fun connectUnselectAll(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

A class@Gtk.SignalAction which gets emitted when the user unselects all items.

contains

open fun contains(x: Double, y: Double): Boolean

Tests if the point at (@x, @y) is contained in @widget.

createDragIcon

open fun createDragIcon(path: TreePath): <Error class: unknown class>?

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

createPangoLayout

open fun createPangoLayout(text: String? = null): <Error class: unknown class>

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

disposeTemplate

open fun disposeTemplate(widgetType: <Error class: unknown class>)

Clears the template children for the given widget.

dragCheckThreshold

open fun dragCheckThreshold(startX: Int, startY: Int, currentX: Int, currentY: Int): Boolean

Checks to see if a drag movement has passed the GTK drag threshold.

enableModelDragDest

open fun enableModelDragDest(formats: <Error class: unknown class>, actions: <Error class: unknown class>)

Turns @icon_view into a drop destination for automatic DND. Calling this method sets GtkIconView:reorderable to false.

enableModelDragSource

open fun enableModelDragSource(startButtonMask: <Error class: unknown class>, formats: <Error class: unknown class>, actions: <Error class: unknown class>)

Turns @icon_view into a drag source for automatic DND. Calling this method sets GtkIconView:reorderable to false.

errorBell

open fun errorBell()

Notifies the user about an input-related error on this widget.

getAccessibleParent

open fun getAccessibleParent(): Accessible?

Retrieves the accessible parent for an accessible object.

getAccessibleRole

open fun getAccessibleRole(): AccessibleRole

Retrieves the accessible role of an accessible object.

getActivateOnSingleClick

open fun getActivateOnSingleClick(): Boolean

Gets the setting set by gtk_icon_view_set_activate_on_single_click().

getAllocatedBaseline

open fun getAllocatedBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getAllocatedHeight

open fun getAllocatedHeight(): Int

Returns the height that has currently been allocated to @widget.

getAllocatedWidth

open fun getAllocatedWidth(): Int

Returns the width that has currently been allocated to @widget.

getAncestor

open fun getAncestor(widgetType: <Error class: unknown class>): Widget?

Gets the first ancestor of @widget with type @widget_type.

getArea

open fun getArea(): CellArea?

Returns the underlying GtkCellArea which might be @cell_layout if called on a GtkCellArea or might be null if no GtkCellArea is used by @cell_layout.

getAtContext

open fun getAtContext(): ATContext

Retrieves the accessible implementation for the given GtkAccessible.

getBaseline

open fun getBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getBorder

open fun getBorder(border: Border): Boolean

Returns the size of a non-scrolling border around the outside of the scrollable.

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCanFocus

open fun getCanFocus(): Boolean

Determines whether the input focus can enter @widget or any of its children.

getCanTarget

open fun getCanTarget(): Boolean

Queries whether @widget can be the target of pointer events.

getCellRect

open fun getCellRect(path: TreePath, cell: CellRenderer? = null, rect: <Error class: unknown class>): Boolean

Fills the bounding rectangle in widget coordinates for the cell specified by

getCells

open fun getCells(): <Error class: unknown class>

Returns the cell renderers which have been added to @cell_layout.

getChildVisible

open fun getChildVisible(): Boolean

Gets the value set with gtk_widget_set_child_visible().

getClipboard

open fun getClipboard(): <Error class: unknown class>

Gets the clipboard object for @widget.

getColor

open fun getColor(color: <Error class: unknown class>)

Gets the current foreground color for the widget’s CSS style.

getColumns

open fun getColumns(): Int

Returns the value of the ::columns property.

getColumnSpacing

open fun getColumnSpacing(): Int

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

getCssClasses

open fun getCssClasses(): List<String>

Returns the list of style classes applied to @widget.

getCssName

open fun getCssName(): String

Returns the CSS name that is used for @self.

getCursor

open fun getCursor(): <Error class: unknown class>?

Queries the cursor set on @widget.

getDirection

open fun getDirection(): TextDirection

Gets the reading direction for a particular widget.

getDisplay

open fun getDisplay(): <Error class: unknown class>

Get the GdkDisplay for the toplevel window associated with this widget.

getFirstAccessibleChild

open fun getFirstAccessibleChild(): Accessible?

Retrieves the first accessible child of an accessible object.

getFirstChild

open fun getFirstChild(): Widget?

Returns the widget’s first child.

getFocusable

open fun getFocusable(): Boolean

Determines whether @widget can own the input focus.

getFocusChild

open fun getFocusChild(): Widget?

Returns the current focus child of @widget.

getFocusOnClick

open fun getFocusOnClick(): Boolean

Returns whether the widget should grab focus when it is clicked with the mouse.

getFontMap

open fun getFontMap(): <Error class: unknown class>?

Gets the font map of @widget.

getFrameClock

open fun getFrameClock(): <Error class: unknown class>?

Obtains the frame clock for a widget.

getHadjustment

open fun getHadjustment(): Adjustment?

Retrieves the GtkAdjustment used for horizontal scrolling.

getHalign

open fun getHalign(): Align

Gets the horizontal alignment of @widget.

getHasTooltip

open fun getHasTooltip(): Boolean

Returns the current value of the has-tooltip property.

getHeight

open fun getHeight(): Int

Returns the content height of the widget.

getHexpand

open fun getHexpand(): Boolean

Gets whether the widget would like any available extra horizontal space.

getHexpandSet

open fun getHexpandSet(): Boolean

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

getHscrollPolicy

open fun getHscrollPolicy(): ScrollablePolicy

Gets the horizontal GtkScrollablePolicy.

getItemColumn

open fun getItemColumn(path: TreePath): Int

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

getItemOrientation

open fun getItemOrientation(): Orientation

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

getItemPadding

open fun getItemPadding(): Int

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

getItemRow

open fun getItemRow(path: TreePath): Int

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

getItemWidth

open fun getItemWidth(): Int

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

getLastChild

open fun getLastChild(): Widget?

Returns the widget’s last child.

getLayoutManager

open fun getLayoutManager(): LayoutManager?

Retrieves the layout manager used by @widget.

getMapped

open fun getMapped(): Boolean

Whether the widget is mapped.

getMargin

open fun getMargin(): Int

Returns the value of the ::margin property.

getMarginBottom

open fun getMarginBottom(): Int

Gets the bottom margin of @widget.

getMarginEnd

open fun getMarginEnd(): Int

Gets the end margin of @widget.

getMarginStart

open fun getMarginStart(): Int

Gets the start margin of @widget.

getMarginTop

open fun getMarginTop(): Int

Gets the top margin of @widget.

getMarkupColumn

open fun getMarkupColumn(): Int

Returns the column with markup text for @icon_view.

getModel

open fun getModel(): TreeModel?

Returns the model the GtkIconView is based on. Returns null if the model is unset.

getName

open fun getName(): String

Retrieves the name of a widget.

getNative

open fun getNative(): Native?

Returns the nearest GtkNative ancestor of @widget.

getNextAccessibleSibling

open fun getNextAccessibleSibling(): Accessible?

Retrieves the next accessible sibling of an accessible object

getNextSibling

open fun getNextSibling(): Widget?

Returns the widget’s next sibling.

getOpacity

open fun getOpacity(): Double

#Fetches the requested opacity for this widget.

getOverflow

open fun getOverflow(): Overflow

Returns the widget’s overflow value.

getParent

open fun getParent(): Widget?

Returns the parent widget of @widget.

getPathAtPos

open fun getPathAtPos(x: Int, y: Int): TreePath?

Gets the path for the icon at the given position.

getPixbufColumn

open fun getPixbufColumn(): Int

Returns the column with pixbufs for @icon_view.

getPlatformState

open fun getPlatformState(state: AccessiblePlatformState): Boolean

Query a platform state, such as focus.

getPreferredSize

open fun getPreferredSize(minimumSize: Requisition?, naturalSize: Requisition?)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

getPrevSibling

open fun getPrevSibling(): Widget?

Returns the widget’s previous sibling.

getPrimaryClipboard

open fun getPrimaryClipboard(): <Error class: unknown class>

Gets the primary clipboard of @widget.

getRealized

open fun getRealized(): Boolean

Determines whether @widget is realized.

getReceivesDefault

open fun getReceivesDefault(): Boolean

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.

getReorderable

open fun getReorderable(): Boolean

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

getRequestMode

open fun getRequestMode(): SizeRequestMode

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

getRoot

open fun getRoot(): Root?

Returns the GtkRoot widget of @widget.

getRowSpacing

open fun getRowSpacing(): Int

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

getScaleFactor

open fun getScaleFactor(): Int

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

getSelectedItems

open fun getSelectedItems(): <Error class: unknown class>

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().

getSelectionMode

open fun getSelectionMode(): SelectionMode

Gets the selection mode of the @icon_view.

getSensitive

open fun getSensitive(): Boolean

Returns the widget’s sensitivity.

getSettings

open fun getSettings(): Settings

Gets the settings object holding the settings used for this widget.

getSize

open fun getSize(orientation: Orientation): Int

Returns the content width or height of the widget.

getSpacing

open fun getSpacing(): Int

Returns the value of the ::spacing property.

getStateFlags

open fun getStateFlags(): StateFlags

Returns the widget state as a flag set.

getStyleContext

open fun getStyleContext(): StyleContext

Returns the style context associated to @widget.

getTemplateChild

open fun getTemplateChild(widgetType: <Error class: unknown class>, name: String): <Error class: unknown class>

Fetch an object build from the template XML for @widget_type in this @widget instance.

getTextColumn

open fun getTextColumn(): Int

Returns the column with text for @icon_view.

getTooltipColumn

open fun getTooltipColumn(): Int

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

getTooltipMarkup

open fun getTooltipMarkup(): String?

Gets the contents of the tooltip for @widget.

getTooltipText

open fun getTooltipText(): String?

Gets the contents of the tooltip for @widget.

getVadjustment

open fun getVadjustment(): Adjustment?

Retrieves the GtkAdjustment used for vertical scrolling.

getValign

open fun getValign(): Align

Gets the vertical alignment of @widget.

getVexpand

open fun getVexpand(): Boolean

Gets whether the widget would like any available extra vertical space.

getVexpandSet

open fun getVexpandSet(): Boolean

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

getVisible

open fun getVisible(): Boolean

Determines whether the widget is visible.

getVscrollPolicy

open fun getVscrollPolicy(): ScrollablePolicy

Gets the vertical GtkScrollablePolicy.

getWidth

open fun getWidth(): Int

Returns the content width of the widget.

grabFocus

open fun grabFocus(): Boolean

Causes @widget to have the keyboard focus for the GtkWindow it's inside.

hasCssClass

open fun hasCssClass(cssClass: String): Boolean

Returns whether @css_class is currently applied to @widget.

hasDefault

open fun hasDefault(): Boolean

Determines whether @widget is the current default widget within its toplevel.

hasFocus

open fun hasFocus(): Boolean

Determines if the widget has the global input focus.

hasVisibleFocus

open fun hasVisibleFocus(): Boolean

Determines if the widget should show a visible indication that it has the global input focus.

hide

open fun hide()

Reverses the effects of gtk_widget_show().

inDestruction

open fun inDestruction(): Boolean

Returns whether the widget is currently being destroyed.

initTemplate

open fun initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup

open fun insertActionGroup(name: String, group: <Error class: unknown class>? = null)

Inserts @group into @widget.

insertAfter

open fun insertAfter(parent: Widget, previousSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

insertBefore

open fun insertBefore(parent: Widget, nextSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

isAncestor

open fun isAncestor(ancestor: Widget): Boolean

Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

isDrawable

open fun isDrawable(): Boolean

Determines whether @widget can be drawn to.

isFocus

open fun isFocus(): Boolean

Determines if the widget is the focus widget within its toplevel.

isSensitive

open fun isSensitive(): Boolean

Returns the widget’s effective sensitivity.

isVisible

open fun isVisible(): Boolean

Determines whether the widget and all its parents are marked as visible.

itemActivated

open fun itemActivated(path: TreePath)

Activates the item determined by @path.

keynavFailed

open fun keynavFailed(direction: DirectionType): Boolean

Emits the ::keynav-failed signal on the widget.

listMnemonicLabels

open fun listMnemonicLabels(): <Error class: unknown class>

Returns the widgets for which this widget is the target of a mnemonic.

map

open fun map()

Causes a widget to be mapped if it isn’t already.

mnemonicActivate

open fun mnemonicActivate(groupCycling: Boolean): Boolean

Emits the ::mnemonic-activate signal.

observeChildren

open fun observeChildren(): <Error class: unknown class>

Returns a GListModel to track the children of @widget.

observeControllers

open fun observeControllers(): <Error class: unknown class>

Returns a GListModel to track the class@Gtk.EventControllers of @widget.

packEnd

open fun packEnd(cell: CellRenderer, expand: Boolean)

Adds the @cell to the end of @cell_layout. If @expand is false, then the

packStart

open fun packStart(cell: CellRenderer, expand: Boolean)

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.

pathIsSelected

open fun pathIsSelected(path: TreePath): Boolean

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

pick

open fun pick(x: Double, y: Double, flags: PickFlags): Widget?

Finds the descendant of @widget closest to the point (@x, @y).

queueAllocate

open fun queueAllocate()

Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.

queueDraw

open fun queueDraw()

Schedules this widget to be redrawn in the paint phase of the current or the next frame.

queueResize

open fun queueResize()

Flags a widget to have its size renegotiated.

realize

open fun realize()

Creates the GDK resources associated with a widget.

removeController

open fun removeController(controller: EventController)

Removes @controller from @widget, so that it doesn't process events anymore.

removeCssClass

open fun removeCssClass(cssClass: String)

Removes a style from @widget.

removeMnemonicLabel

open fun removeMnemonicLabel(label: Widget)

Removes a widget from the list of mnemonic labels for this widget.

removeTickCallback

open fun removeTickCallback(id: <Error class: unknown class>)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

reorder

open fun reorder(cell: CellRenderer, position: Int)

Re-inserts @cell at @position.

resetProperty

open fun resetProperty(property: AccessibleProperty)

Resets the accessible @property to its default value.

resetRelation

open fun resetRelation(relation: AccessibleRelation)

Resets the accessible @relation to its default value.

resetState

open fun resetState(state: AccessibleState)

Resets the accessible @state to its default value.

scrollToPath

open fun scrollToPath(path: TreePath, useAlign: Boolean, rowAlign: Float, colAlign: Float)

Moves the alignments of @icon_view to the position specified by @path.

selectAll

open fun selectAll()

Selects all the icons. @icon_view must has its selection mode set to %GTK_SELECTION_MULTIPLE.

selectedForeach

open fun selectedForeach(func: IconViewForeachFunc)

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

selectPath

open fun selectPath(path: TreePath)

Selects the row at @path.

setAccessibleParent

open fun setAccessibleParent(parent: Accessible? = null, nextSibling: Accessible? = null)

Sets the parent and sibling of an accessible object.

setActivateOnSingleClick

open fun setActivateOnSingleClick(single: Boolean)

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

setCanFocus

open fun setCanFocus(canFocus: Boolean)

Specifies whether the input focus can enter the widget or any of its children.

setCanTarget

open fun setCanTarget(canTarget: Boolean)

Sets whether @widget can be the target of pointer events.

setCellDataFunc

open fun setCellDataFunc(cell: CellRenderer, func: CellLayoutDataFunc)

Sets the GtkCellLayoutDataFunc to use for @cell_layout.

setChildVisible

open fun setChildVisible(childVisible: Boolean)

Sets whether @widget should be mapped along with its parent.

setColumns

open fun setColumns(columns: Int)

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.

setColumnSpacing

open fun setColumnSpacing(columnSpacing: Int)

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

setCssClasses

open fun setCssClasses(classes: List<String>)

Clear all style classes applied to @widget and replace them with @classes.

setCursor

open fun setCursor(cursor: <Error class: unknown class>? = null)

Sets the cursor to be shown when pointer devices point towards @widget.

setCursor_

open fun setCursor_(path: TreePath, cell: CellRenderer? = null, startEditing: Boolean)

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.

setCursorFromName

open fun setCursorFromName(name: String? = null)

Sets a named cursor to be shown when pointer devices point towards @widget.

setDirection

open fun setDirection(dir: TextDirection)

Sets the reading direction on a particular widget.

setDragDestItem

open fun setDragDestItem(path: TreePath? = null, pos: IconViewDropPosition)

Sets the item that is highlighted for feedback.

setFocusable

open fun setFocusable(focusable: Boolean)

Specifies whether @widget can own the input focus.

setFocusChild

open fun setFocusChild(child: Widget? = null)

Set @child as the current focus child of @widget.

setFocusOnClick

open fun setFocusOnClick(focusOnClick: Boolean)

Sets whether the widget should grab focus when it is clicked with the mouse.

setFontMap

open fun setFontMap(fontMap: <Error class: unknown class>? = null)

Sets the font map to use for Pango rendering.

setHadjustment

open fun setHadjustment(hadjustment: Adjustment? = null)

Sets the horizontal adjustment of the GtkScrollable.

setHalign

open fun setHalign(align: Align)

Sets the horizontal alignment of @widget.

setHasTooltip

open fun setHasTooltip(hasTooltip: Boolean)

Sets the has-tooltip property on @widget to @has_tooltip.

setHexpand

open fun setHexpand(expand: Boolean)

Sets whether the widget would like any available extra horizontal space.

setHexpandSet

open fun setHexpandSet(set: Boolean)

Sets whether the hexpand flag will be used.

setHscrollPolicy

open fun setHscrollPolicy(policy: ScrollablePolicy)

Sets the GtkScrollablePolicy.

setItemOrientation

open fun setItemOrientation(orientation: Orientation)

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

setItemPadding

open fun setItemPadding(itemPadding: Int)

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

setItemWidth

open fun setItemWidth(itemWidth: Int)

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.

setLayoutManager

open fun setLayoutManager(layoutManager: LayoutManager? = null)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.

setMargin

open fun setMargin(margin: Int)

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

setMarginBottom

open fun setMarginBottom(margin: Int)

Sets the bottom margin of @widget.

setMarginEnd

open fun setMarginEnd(margin: Int)

Sets the end margin of @widget.

setMargins

fun Widget.setMargins(all: Int)

Set all margins to the same value.

fun Widget.setMargins(horizontal: Int = 0, vertical: Int = 0)

Set start and end margin to horizontal and top and bottom margin to vertical

fun Widget.setMargins(start: Int = 0, top: Int = 0, end: Int = 0, bottom: Int = 0)

Set margins.

setMarginStart

open fun setMarginStart(margin: Int)

Sets the start margin of @widget.

setMarginTop

open fun setMarginTop(margin: Int)

Sets the top margin of @widget.

setMarkupColumn

open fun setMarkupColumn(column: Int)

Sets the column with markup information for @icon_view to be

setModel

open fun setModel(model: TreeModel? = null)

Sets the model for a GtkIconView. If the @icon_view already has a model set, it will remove it before setting the new model. If @model is null, then it will unset the old model.

setName

open fun setName(name: String)

Sets a widgets name.

setOpacity

open fun setOpacity(opacity: Double)

Request the @widget to be rendered partially transparent.

setOverflow

open fun setOverflow(overflow: Overflow)

Sets how @widget treats content that is drawn outside the widget's content area.

setParent

open fun setParent(parent: Widget)

Sets @parent as the parent widget of @widget.

setPixbufColumn

open fun setPixbufColumn(column: Int)

Sets the column with pixbufs for @icon_view to be @column. The pixbuf column must be of type GDK_TYPE_PIXBUF

setReceivesDefault

open fun setReceivesDefault(receivesDefault: Boolean)

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.

setReorderable

open fun setReorderable(reorderable: Boolean)

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.

setRowSpacing

open fun setRowSpacing(rowSpacing: Int)

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

setSelectionMode

open fun setSelectionMode(mode: SelectionMode)

Sets the selection mode of the @icon_view.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the sensitivity of a widget.

setSizeRequest

open fun setSizeRequest(width: Int, height: Int)

Sets the minimum size of a widget.

setSpacing

open fun setSpacing(spacing: Int)

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

setStateFlags

open fun setStateFlags(flags: StateFlags, clear: Boolean)

Turns on flag values in the current widget state.

setTextColumn

open fun setTextColumn(column: Int)

Sets the column with text for @icon_view to be @column. The text column must be of type G_TYPE_STRING.

setTooltipCell

open fun setTooltipCell(tooltip: Tooltip, path: TreePath, cell: CellRenderer? = null)

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().

setTooltipColumn

open fun setTooltipColumn(column: Int)

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.

setTooltipItem

open fun setTooltipItem(tooltip: Tooltip, path: TreePath)

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().

setTooltipMarkup