gi-gtk-3.0.11: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.IconView

Contents

Description

IconView provides an alternative view on a TreeModel. It displays the model as a grid of icons with labels. Like TreeView, it allows to select one or multiple items (depending on the selection mode, see iconViewSetSelectionMode). In addition to selection with the arrow keys, 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), IconView will only display the first level of the tree and ignore the tree’s branches.

CSS nodes

plain code

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.

Synopsis

Exported types

Methods

convertWidgetToBinWindowCoords

iconViewConvertWidgetToBinWindowCoords Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

wx: X coordinate relative to the widget

-> Int32

wy: Y coordinate relative to the widget

-> m (Int32, Int32) 

Converts widget coordinates to coordinates for the bin_window, as expected by e.g. iconViewGetPathAtPos.

Since: 2.12

createDragIcon

iconViewCreateDragIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> TreePath

path: a TreePath in iconView

-> m Surface

Returns: a newly-allocated surface of the drag icon.

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

Since: 2.8

enableModelDragDest

iconViewEnableModelDragDest Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> [TargetEntry]

targets: the table of targets that the drag will support

-> [DragAction]

actions: the bitmask of possible actions for a drag to this widget

-> m () 

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

Since: 2.8

enableModelDragSource

iconViewEnableModelDragSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> [ModifierType]

startButtonMask: Mask of allowed buttons to start drag

-> [TargetEntry]

targets: the table of targets that the drag will support

-> [DragAction]

actions: the bitmask of possible actions for a drag from this widget

-> m () 

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

Since: 2.8

getActivateOnSingleClick

iconViewGetActivateOnSingleClick Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Bool

Returns: True if item-activated will be emitted on a single click

Gets the setting set by iconViewSetActivateOnSingleClick.

Since: 3.8

getCellRect

iconViewGetCellRect Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a, IsCellRenderer b) 
=> a

iconView: a IconView

-> TreePath

path: a TreePath

-> Maybe b

cell: a CellRenderer or Nothing

-> m (Bool, Rectangle)

Returns: False if there is no such item, True otherwise

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

This function is only valid if iconView is realized.

Since: 3.6

getColumnSpacing

iconViewGetColumnSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the space between columns

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

Since: 2.6

getColumns

iconViewGetColumns Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the number of columns, or -1

Returns the value of the ::columns property.

Since: 2.6

getCursor

iconViewGetCursor Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView

-> m (Bool, TreePath, CellRenderer)

Returns: True if the cursor is set.

Fills in path and cell with the current cursor path and cell. If the cursor isn’t currently set, then *path will be Nothing. If no cell currently has focus, then *cell will be Nothing.

The returned TreePath must be freed with treePathFree.

Since: 2.8

getDestItemAtPos

iconViewGetDestItemAtPos Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

dragX: the position to determine the destination item for

-> Int32

dragY: the position to determine the destination item for

-> m (Bool, TreePath, IconViewDropPosition)

Returns: whether there is an item at the given position.

Determines the destination item for a given position.

Since: 2.8

getDragDestItem

iconViewGetDragDestItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m (TreePath, IconViewDropPosition) 

Gets information about the item that is highlighted for feedback.

Since: 2.8

getItemAtPos

iconViewGetItemAtPos Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Int32

x: The x position to be identified

-> Int32

y: The y position to be identified

-> m (Bool, TreePath, CellRenderer)

Returns: True if an item exists at the specified position

Finds the path at the point (x, y), relative to bin_window coordinates. In contrast to iconViewGetPathAtPos, this function also obtains the cell at the specified position. The returned path should be freed with treePathFree. See iconViewConvertWidgetToBinWindowCoords for converting widget coordinates to bin_window coordinates.

Since: 2.8

getItemColumn

iconViewGetItemColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> TreePath

path: the TreePath of the item

-> m Int32

Returns: The column in which the item is displayed

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

Since: 2.22

getItemOrientation

iconViewGetItemOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Orientation

Returns: the relative position of texts and icons

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

Since: 2.6

getItemPadding

iconViewGetItemPadding Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the padding around items

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

Since: 2.18

getItemRow

iconViewGetItemRow Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> TreePath

path: the TreePath of the item

-> m Int32

Returns: The row in which the item is displayed

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

Since: 2.22

getItemWidth

iconViewGetItemWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the width of a single item, or -1

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

Since: 2.6

getMargin

iconViewGetMargin Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the space at the borders

Returns the value of the ::margin property.

Since: 2.6

getMarkupColumn

iconViewGetMarkupColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m Int32

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

Returns the column with markup text for iconView.

Since: 2.6

getModel

iconViewGetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m (Maybe TreeModel)

Returns: A TreeModel, or Nothing if none is currently being used.

Returns the model the IconView is based on. Returns Nothing if the model is unset.

Since: 2.6

getPathAtPos

iconViewGetPathAtPos Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Int32

x: The x position to be identified

-> Int32

y: The y position to be identified

-> m (Maybe TreePath)

Returns: The TreePath corresponding to the icon or Nothing if no icon exists at that position.

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

Since: 2.6

getPixbufColumn

iconViewGetPixbufColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m Int32

Returns: the pixbuf column, or -1 if it’s unset.

Returns the column with pixbufs for iconView.

Since: 2.6

getReorderable

iconViewGetReorderable Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Bool

Returns: True if the list can be reordered.

Retrieves whether the user can reorder the list via drag-and-drop. See iconViewSetReorderable.

Since: 2.8

getRowSpacing

iconViewGetRowSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the space between rows

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

Since: 2.6

getSelectedItems

iconViewGetSelectedItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m [TreePath]

Returns: A List containing a TreePath for each selected row.

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 treeRowReferenceNew.

To free the return value, use:

C code

g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);

Since: 2.6

getSelectionMode

iconViewGetSelectionMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m SelectionMode

Returns: the current selection mode

Gets the selection mode of the iconView.

Since: 2.6

getSpacing

iconViewGetSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

Returns: the space between cells

Returns the value of the ::spacing property.

Since: 2.6

getTextColumn

iconViewGetTextColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m Int32

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

Returns the column with text for iconView.

Since: 2.6

getTooltipColumn

iconViewGetTooltipColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m Int32

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

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

Since: 2.12

getTooltipContext

iconViewGetTooltipContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: an IconView

-> Int32

x: the x coordinate (relative to widget coordinates)

-> Int32

y: the y coordinate (relative to widget coordinates)

-> Bool

keyboardTip: whether this is a keyboard tooltip or not

-> m (Bool, Int32, Int32, TreeModel, TreePath, TreeIter)

Returns: whether or not the given tooltip context points to a item

This function is supposed to be used in a Widget::query-tooltip signal handler for IconView. The x, y and keyboardTip 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 iconView’s bin_window if keyboardTooltip is False.

Since: 2.12

getVisibleRange

iconViewGetVisibleRange Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView

-> m (Bool, TreePath, TreePath)

Returns: True, if valid paths were placed in startPath and endPath

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

Both paths should be freed with treePathFree after use.

Since: 2.8

itemActivated

iconViewItemActivated Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView

-> TreePath

path: The TreePath to be activated

-> m () 

Activates the item determined by path.

Since: 2.6

new

iconViewNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m IconView

Returns: A newly created IconView widget

Creates a new IconView widget

Since: 2.6

newWithArea

iconViewNewWithArea Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellArea a) 
=> a

area: the CellArea to use to layout cells

-> m IconView

Returns: A newly created IconView widget

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

Since: 3.0

newWithModel

iconViewNewWithModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTreeModel a) 
=> a

model: The model.

-> m IconView

Returns: A newly created IconView widget.

Creates a new IconView widget with the model model.

Since: 2.6

pathIsSelected

iconViewPathIsSelected Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> TreePath

path: A TreePath to check selection on.

-> m Bool

Returns: True if path is selected.

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

Since: 2.6

scrollToPath

iconViewScrollToPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> TreePath

path: The path of the item to move to.

-> Bool

useAlign: whether to use alignment arguments, or False.

-> Float

rowAlign: The vertical alignment of the item specified by path.

-> Float

colAlign: The horizontal alignment of the item specified by path.

-> m () 

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

Since: 2.8

selectAll

data IconViewSelectAllMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsIconView a) => MethodInfo * IconViewSelectAllMethodInfo a signature Source # 

iconViewSelectAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m () 

Selects all the icons. iconView must has its selection mode set to GTK_SELECTION_MULTIPLE.

Since: 2.6

selectPath

iconViewSelectPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> TreePath

path: The TreePath to be selected.

-> m () 

Selects the row at path.

Since: 2.6

selectedForeach

iconViewSelectedForeach Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> IconViewForeachFunc

func: The function to call for each selected icon.

-> m () 

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

Since: 2.6

setActivateOnSingleClick

iconViewSetActivateOnSingleClick Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Bool

single: True to emit item-activated on a single click

-> m () 

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

Since: 3.8

setColumnSpacing

iconViewSetColumnSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

columnSpacing: the column spacing

-> m () 

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

Since: 2.6

setColumns

data IconViewSetColumnsMethodInfo Source #

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsIconView a) => MethodInfo * IconViewSetColumnsMethodInfo a signature Source # 

iconViewSetColumns Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

columns: the number of columns

-> m () 

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.

Since: 2.6

setCursor

iconViewSetCursor Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a, IsCellRenderer b) 
=> a

iconView: A IconView

-> TreePath

path: A TreePath

-> Maybe b

cell: One of the cell renderers of iconView, or Nothing

-> Bool

startEditing: True if the specified cell should start being edited.

-> m () 

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 Nothing, then focus is given to the cell specified by it. Additionally, if startEditing 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.

Since: 2.8

setDragDestItem

iconViewSetDragDestItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Maybe TreePath

path: The path of the item to highlight, or Nothing.

-> IconViewDropPosition

pos: Specifies where to drop, relative to the item

-> m () 

Sets the item that is highlighted for feedback.

Since: 2.8

setItemOrientation

iconViewSetItemOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Orientation

orientation: the relative position of texts and icons

-> m () 

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

Since: 2.6

setItemPadding

iconViewSetItemPadding Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

itemPadding: the item padding

-> m () 

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

Since: 2.18

setItemWidth

iconViewSetItemWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

itemWidth: the width for each item

-> m () 

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.

Since: 2.6

setMargin

data IconViewSetMarginMethodInfo Source #

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsIconView a) => MethodInfo * IconViewSetMarginMethodInfo a signature Source # 

iconViewSetMargin Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

margin: the margin

-> m () 

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

Since: 2.6

setMarkupColumn

iconViewSetMarkupColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Int32

column: A column in the currently used model, or -1 to display no text

-> m () 

Sets the column with markup information for iconView to be column. The markup column must be of type G_TYPE_STRING. If the markup column is set to something, it overrides the text column set by iconViewSetTextColumn.

Since: 2.6

setModel

data IconViewSetModelMethodInfo Source #

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsIconView a, IsTreeModel b) => MethodInfo * IconViewSetModelMethodInfo a signature Source # 

iconViewSetModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a, IsTreeModel b) 
=> a

iconView: A IconView.

-> Maybe b

model: The model.

-> m () 

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

Since: 2.6

setPixbufColumn

iconViewSetPixbufColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Int32

column: A column in the currently used model, or -1 to disable

-> m () 

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

Since: 2.6

setReorderable

iconViewSetReorderable Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Bool

reorderable: True, if the list of items can be reordered.

-> m () 

This function is a convenience function to allow you to reorder models that support the TreeDragSourceIface and the TreeDragDestIface. Both TreeStore and 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.

Since: 2.8

setRowSpacing

iconViewSetRowSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

rowSpacing: the row spacing

-> m () 

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

Since: 2.6

setSelectionMode

iconViewSetSelectionMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> SelectionMode

mode: The selection mode

-> m () 

Sets the selection mode of the iconView.

Since: 2.6

setSpacing

data IconViewSetSpacingMethodInfo Source #

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsIconView a) => MethodInfo * IconViewSetSpacingMethodInfo a signature Source # 

iconViewSetSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

spacing: the spacing

-> m () 

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

Since: 2.6

setTextColumn

iconViewSetTextColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> Int32

column: A column in the currently used model, or -1 to display no text

-> m () 

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

Since: 2.6

setTooltipCell

iconViewSetTooltipCell Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a, IsTooltip b, IsCellRenderer c) 
=> a

iconView: a IconView

-> b

tooltip: a Tooltip

-> TreePath

path: a TreePath

-> Maybe c

cell: a CellRenderer or Nothing

-> m () 

Sets the tip area of tooltip to the area which cell occupies in the item pointed to by path. See also tooltipSetTipArea.

See also iconViewSetTooltipColumn for a simpler alternative.

Since: 2.12

setTooltipColumn

iconViewSetTooltipColumn Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> Int32

column: an integer, which is a valid column number for iconView’s model

-> m () 

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

When enabled, Widget:has-tooltip will be set to True and iconView will connect a Widget::query-tooltip signal handler.

Note that the signal handler sets the text with tooltipSetMarkup, so &, <, etc have to be escaped in the text.

Since: 2.12

setTooltipItem

iconViewSetTooltipItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a, IsTooltip b) 
=> a

iconView: a IconView

-> b

tooltip: a Tooltip

-> TreePath

path: a TreePath

-> m () 

Sets the tip area of tooltip to be the area covered by the item at path. See also iconViewSetTooltipColumn for a simpler alternative. See also tooltipSetTipArea.

Since: 2.12

unselectAll

iconViewUnselectAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> m () 

Unselects all the icons.

Since: 2.6

unselectPath

iconViewUnselectPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: A IconView.

-> TreePath

path: The TreePath to be unselected.

-> m () 

Unselects the row at path.

Since: 2.6

unsetModelDragDest

iconViewUnsetModelDragDest Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m () 

Undoes the effect of iconViewEnableModelDragDest. Calling this method sets IconView:reorderable to False.

Since: 2.8

unsetModelDragSource

iconViewUnsetModelDragSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsIconView a) 
=> a

iconView: a IconView

-> m () 

Undoes the effect of iconViewEnableModelDragSource. Calling this method sets IconView:reorderable to False.

Since: 2.8

Properties

activateOnSingleClick

data IconViewActivateOnSingleClickPropertyInfo Source #

Instances

AttrInfo IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrOrigin IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrLabel IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrLabel IconViewActivateOnSingleClickPropertyInfo = "activate-on-single-click"
type AttrGetType IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrSetTypeConstraint IconViewActivateOnSingleClickPropertyInfo Source # 
type AttrAllowedOps IconViewActivateOnSingleClickPropertyInfo Source # 

cellArea

data IconViewCellAreaPropertyInfo Source #

Instances

AttrInfo IconViewCellAreaPropertyInfo Source # 
type AttrOrigin IconViewCellAreaPropertyInfo Source # 
type AttrLabel IconViewCellAreaPropertyInfo Source # 
type AttrGetType IconViewCellAreaPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewCellAreaPropertyInfo Source # 
type AttrSetTypeConstraint IconViewCellAreaPropertyInfo Source # 
type AttrAllowedOps IconViewCellAreaPropertyInfo Source # 

columnSpacing

data IconViewColumnSpacingPropertyInfo Source #

Instances

AttrInfo IconViewColumnSpacingPropertyInfo Source # 
type AttrOrigin IconViewColumnSpacingPropertyInfo Source # 
type AttrLabel IconViewColumnSpacingPropertyInfo Source # 
type AttrGetType IconViewColumnSpacingPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewColumnSpacingPropertyInfo Source # 
type AttrSetTypeConstraint IconViewColumnSpacingPropertyInfo Source # 
type AttrAllowedOps IconViewColumnSpacingPropertyInfo Source # 

columns

data IconViewColumnsPropertyInfo Source #

Instances

AttrInfo IconViewColumnsPropertyInfo Source # 
type AttrOrigin IconViewColumnsPropertyInfo Source # 
type AttrLabel IconViewColumnsPropertyInfo Source # 
type AttrGetType IconViewColumnsPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewColumnsPropertyInfo Source # 
type AttrSetTypeConstraint IconViewColumnsPropertyInfo Source # 
type AttrAllowedOps IconViewColumnsPropertyInfo Source # 

itemOrientation

data IconViewItemOrientationPropertyInfo Source #

Instances

AttrInfo IconViewItemOrientationPropertyInfo Source # 
type AttrOrigin IconViewItemOrientationPropertyInfo Source # 
type AttrLabel IconViewItemOrientationPropertyInfo Source # 
type AttrGetType IconViewItemOrientationPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewItemOrientationPropertyInfo Source # 
type AttrSetTypeConstraint IconViewItemOrientationPropertyInfo Source # 
type AttrAllowedOps IconViewItemOrientationPropertyInfo Source # 

itemPadding

data IconViewItemPaddingPropertyInfo Source #

Instances

AttrInfo IconViewItemPaddingPropertyInfo Source # 
type AttrOrigin IconViewItemPaddingPropertyInfo Source # 
type AttrLabel IconViewItemPaddingPropertyInfo Source # 
type AttrGetType IconViewItemPaddingPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewItemPaddingPropertyInfo Source # 
type AttrSetTypeConstraint IconViewItemPaddingPropertyInfo Source # 
type AttrAllowedOps IconViewItemPaddingPropertyInfo Source # 

itemWidth

data IconViewItemWidthPropertyInfo Source #

Instances

AttrInfo IconViewItemWidthPropertyInfo Source # 
type AttrOrigin IconViewItemWidthPropertyInfo Source # 
type AttrLabel IconViewItemWidthPropertyInfo Source # 
type AttrGetType IconViewItemWidthPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewItemWidthPropertyInfo Source # 
type AttrSetTypeConstraint IconViewItemWidthPropertyInfo Source # 
type AttrAllowedOps IconViewItemWidthPropertyInfo Source # 

margin

data IconViewMarginPropertyInfo Source #

Instances

AttrInfo IconViewMarginPropertyInfo Source # 
type AttrOrigin IconViewMarginPropertyInfo Source # 
type AttrLabel IconViewMarginPropertyInfo Source # 
type AttrGetType IconViewMarginPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewMarginPropertyInfo Source # 
type AttrSetTypeConstraint IconViewMarginPropertyInfo Source # 
type AttrAllowedOps IconViewMarginPropertyInfo Source # 

setIconViewMargin :: (MonadIO m, IsIconView o) => o -> Int32 -> m () Source #

markupColumn

data IconViewMarkupColumnPropertyInfo Source #

Instances

AttrInfo IconViewMarkupColumnPropertyInfo Source # 
type AttrOrigin IconViewMarkupColumnPropertyInfo Source # 
type AttrLabel IconViewMarkupColumnPropertyInfo Source # 
type AttrGetType IconViewMarkupColumnPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewMarkupColumnPropertyInfo Source # 
type AttrSetTypeConstraint IconViewMarkupColumnPropertyInfo Source # 
type AttrAllowedOps IconViewMarkupColumnPropertyInfo Source # 

model

data IconViewModelPropertyInfo Source #

Instances

AttrInfo IconViewModelPropertyInfo Source # 
type AttrOrigin IconViewModelPropertyInfo Source # 
type AttrLabel IconViewModelPropertyInfo Source # 
type AttrGetType IconViewModelPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewModelPropertyInfo Source # 
type AttrSetTypeConstraint IconViewModelPropertyInfo Source # 
type AttrAllowedOps IconViewModelPropertyInfo Source # 

setIconViewModel :: (MonadIO m, IsIconView o, IsTreeModel a) => o -> a -> m () Source #

pixbufColumn

data IconViewPixbufColumnPropertyInfo Source #

Instances

AttrInfo IconViewPixbufColumnPropertyInfo Source # 
type AttrOrigin IconViewPixbufColumnPropertyInfo Source # 
type AttrLabel IconViewPixbufColumnPropertyInfo Source # 
type AttrGetType IconViewPixbufColumnPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewPixbufColumnPropertyInfo Source # 
type AttrSetTypeConstraint IconViewPixbufColumnPropertyInfo Source # 
type AttrAllowedOps IconViewPixbufColumnPropertyInfo Source # 

reorderable

data IconViewReorderablePropertyInfo Source #

Instances

AttrInfo IconViewReorderablePropertyInfo Source # 
type AttrOrigin IconViewReorderablePropertyInfo Source # 
type AttrLabel IconViewReorderablePropertyInfo Source # 
type AttrGetType IconViewReorderablePropertyInfo Source # 
type AttrBaseTypeConstraint IconViewReorderablePropertyInfo Source # 
type AttrSetTypeConstraint IconViewReorderablePropertyInfo Source # 
type AttrAllowedOps IconViewReorderablePropertyInfo Source # 

rowSpacing

data IconViewRowSpacingPropertyInfo Source #

Instances

AttrInfo IconViewRowSpacingPropertyInfo Source # 
type AttrOrigin IconViewRowSpacingPropertyInfo Source # 
type AttrLabel IconViewRowSpacingPropertyInfo Source # 
type AttrGetType IconViewRowSpacingPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewRowSpacingPropertyInfo Source # 
type AttrSetTypeConstraint IconViewRowSpacingPropertyInfo Source # 
type AttrAllowedOps IconViewRowSpacingPropertyInfo Source # 

selectionMode

data IconViewSelectionModePropertyInfo Source #

Instances

AttrInfo IconViewSelectionModePropertyInfo Source # 
type AttrOrigin IconViewSelectionModePropertyInfo Source # 
type AttrLabel IconViewSelectionModePropertyInfo Source # 
type AttrGetType IconViewSelectionModePropertyInfo Source # 
type AttrBaseTypeConstraint IconViewSelectionModePropertyInfo Source # 
type AttrSetTypeConstraint IconViewSelectionModePropertyInfo Source # 
type AttrAllowedOps IconViewSelectionModePropertyInfo Source # 

spacing

data IconViewSpacingPropertyInfo Source #

Instances

AttrInfo IconViewSpacingPropertyInfo Source # 
type AttrOrigin IconViewSpacingPropertyInfo Source # 
type AttrLabel IconViewSpacingPropertyInfo Source # 
type AttrGetType IconViewSpacingPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewSpacingPropertyInfo Source # 
type AttrSetTypeConstraint IconViewSpacingPropertyInfo Source # 
type AttrAllowedOps IconViewSpacingPropertyInfo Source # 

textColumn

data IconViewTextColumnPropertyInfo Source #

Instances

AttrInfo IconViewTextColumnPropertyInfo Source # 
type AttrOrigin IconViewTextColumnPropertyInfo Source # 
type AttrLabel IconViewTextColumnPropertyInfo Source # 
type AttrGetType IconViewTextColumnPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewTextColumnPropertyInfo Source # 
type AttrSetTypeConstraint IconViewTextColumnPropertyInfo Source # 
type AttrAllowedOps IconViewTextColumnPropertyInfo Source # 

tooltipColumn

data IconViewTooltipColumnPropertyInfo Source #

Instances

AttrInfo IconViewTooltipColumnPropertyInfo Source # 
type AttrOrigin IconViewTooltipColumnPropertyInfo Source # 
type AttrLabel IconViewTooltipColumnPropertyInfo Source # 
type AttrGetType IconViewTooltipColumnPropertyInfo Source # 
type AttrBaseTypeConstraint IconViewTooltipColumnPropertyInfo Source # 
type AttrSetTypeConstraint IconViewTooltipColumnPropertyInfo Source # 
type AttrAllowedOps IconViewTooltipColumnPropertyInfo Source # 

Signals

activateCursorItem

itemActivated

moveCursor

selectAll

selectCursorItem

selectionChanged

toggleCursorItem

unselectAll