GtkIconView

typedef struct _GtkIconView GtkIconView;

The GtkIconView struct contains only private fields and should not be directly accessed.

GtkIconViewForeachFunc ()

void                (*GtkIconViewForeachFunc)           (GtkIconView *icon_view,
                                                         GtkTreePath *path,
                                                         gpointer data);

A function used by gtk_icon_view_selected_foreach() to map all selected rows. It will be called on every selected row in the view.

gtk_icon_view_new ()

GtkWidget*          gtk_icon_view_new                   (void);

Creates a new GtkIconView widget

Since 2.6

gtk_icon_view_new_with_model ()

GtkWidget*          gtk_icon_view_new_with_model        (GtkTreeModel *model);

Creates a new GtkIconView widget with the model model.

Since 2.6

gtk_icon_view_set_model ()

void                gtk_icon_view_set_model             (GtkIconView *icon_view,
                                                         GtkTreeModel *model);

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.

Since 2.6

gtk_icon_view_get_model ()

GtkTreeModel*       gtk_icon_view_get_model             (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_set_text_column ()

void                gtk_icon_view_set_text_column       (GtkIconView *icon_view,
                                                         gint column);

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

Since 2.6

gtk_icon_view_get_text_column ()

gint                gtk_icon_view_get_text_column       (GtkIconView *icon_view);

Returns the column with text for icon_view.

Since 2.6

gtk_icon_view_set_markup_column ()

void                gtk_icon_view_set_markup_column     (GtkIconView *icon_view,
                                                         gint column);

Sets the column with markup information for icon_view 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 gtk_icon_view_set_text_column().

Since 2.6

gtk_icon_view_get_markup_column ()

gint                gtk_icon_view_get_markup_column     (GtkIconView *icon_view);

Returns the column with markup text for icon_view.

Since 2.6

gtk_icon_view_set_pixbuf_column ()

void                gtk_icon_view_set_pixbuf_column     (GtkIconView *icon_view,
                                                         gint column);

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

Since 2.6

gtk_icon_view_get_pixbuf_column ()

gint                gtk_icon_view_get_pixbuf_column     (GtkIconView *icon_view);

Returns the column with pixbufs for icon_view.

Since 2.6

gtk_icon_view_get_path_at_pos ()

GtkTreePath*        gtk_icon_view_get_path_at_pos       (GtkIconView *icon_view,
                                                         gint x,
                                                         gint y);

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

Since 2.6

gtk_icon_view_get_item_at_pos ()

gboolean            gtk_icon_view_get_item_at_pos       (GtkIconView *icon_view,
                                                         gint x,
                                                         gint y,
                                                         GtkTreePath **path,
                                                         GtkCellRenderer **cell);

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

Since 2.8

gtk_icon_view_convert_widget_to_bin_window_coords ()

void                gtk_icon_view_convert_widget_to_bin_window_coords
                                                        (GtkIconView *icon_view,
                                                         gint wx,
                                                         gint wy,
                                                         gint *bx,
                                                         gint *by);

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

Since 2.12

gtk_icon_view_set_cursor ()

void                gtk_icon_view_set_cursor            (GtkIconView *icon_view,
                                                         GtkTreePath *path,
                                                         GtkCellRenderer *cell,
                                                         gboolean start_editing);

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.

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

gtk_icon_view_get_cursor ()

gboolean            gtk_icon_view_get_cursor            (GtkIconView *icon_view,
                                                         GtkTreePath **path,
                                                         GtkCellRenderer **cell);

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

The returned GtkTreePath must be freed with gtk_tree_path_free().

Since 2.8

gtk_icon_view_selected_foreach ()

void                gtk_icon_view_selected_foreach      (GtkIconView *icon_view,
                                                         GtkIconViewForeachFunc func,
                                                         gpointer data);

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

Since 2.6

gtk_icon_view_set_selection_mode ()

void                gtk_icon_view_set_selection_mode    (GtkIconView *icon_view,
                                                         GtkSelectionMode mode);

Sets the selection mode of the icon_view.

Since 2.6

gtk_icon_view_get_selection_mode ()

GtkSelectionMode    gtk_icon_view_get_selection_mode    (GtkIconView *icon_view);

Gets the selection mode of the icon_view.

Since 2.6

gtk_icon_view_set_orientation ()

void                gtk_icon_view_set_orientation       (GtkIconView *icon_view,
                                                         GtkOrientation orientation);

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

Since 2.6

gtk_icon_view_get_orientation ()

GtkOrientation      gtk_icon_view_get_orientation       (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_set_columns ()

void                gtk_icon_view_set_columns           (GtkIconView *icon_view,
                                                         gint columns);

Sets the ::columns property which determines in how many columns the icons are arranged. If columns is -1, the number of columns will be chosen automatically to fill the available area.

Since 2.6

gtk_icon_view_get_columns ()

gint                gtk_icon_view_get_columns           (GtkIconView *icon_view);

Returns the value of the ::columns property.

Since 2.6

gtk_icon_view_set_item_width ()

void                gtk_icon_view_set_item_width        (GtkIconView *icon_view,
                                                         gint item_width);

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

gtk_icon_view_get_item_width ()

gint                gtk_icon_view_get_item_width        (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_set_spacing ()

void                gtk_icon_view_set_spacing           (GtkIconView *icon_view,
                                                         gint spacing);

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

Since 2.6

gtk_icon_view_get_spacing ()

gint                gtk_icon_view_get_spacing           (GtkIconView *icon_view);

Returns the value of the ::spacing property.

Since 2.6

gtk_icon_view_set_row_spacing ()

void                gtk_icon_view_set_row_spacing       (GtkIconView *icon_view,
                                                         gint row_spacing);

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

Since 2.6

gtk_icon_view_get_row_spacing ()

gint                gtk_icon_view_get_row_spacing       (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_set_column_spacing ()

void                gtk_icon_view_set_column_spacing    (GtkIconView *icon_view,
                                                         gint column_spacing);

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

Since 2.6

gtk_icon_view_get_column_spacing ()

gint                gtk_icon_view_get_column_spacing    (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_set_margin ()

void                gtk_icon_view_set_margin            (GtkIconView *icon_view,
                                                         gint margin);

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

gtk_icon_view_get_margin ()

gint                gtk_icon_view_get_margin            (GtkIconView *icon_view);

Returns the value of the ::margin property.

Since 2.6

gtk_icon_view_select_path ()

void                gtk_icon_view_select_path           (GtkIconView *icon_view,
                                                         GtkTreePath *path);

Selects the row at path.

Since 2.6

gtk_icon_view_unselect_path ()

void                gtk_icon_view_unselect_path         (GtkIconView *icon_view,
                                                         GtkTreePath *path);

Unselects the row at path.

Since 2.6

gtk_icon_view_path_is_selected ()

gboolean            gtk_icon_view_path_is_selected      (GtkIconView *icon_view,
                                                         GtkTreePath *path);

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

gtk_icon_view_get_selected_items ()

GList*              gtk_icon_view_get_selected_items    (GtkIconView *icon_view);

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

To free the return value, use:

g_list_foreach (list, gtk_tree_path_free, NULL);
g_list_free (list);

Since 2.6

gtk_icon_view_select_all ()

void                gtk_icon_view_select_all            (GtkIconView *icon_view);

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

Since 2.6

gtk_icon_view_unselect_all ()

void                gtk_icon_view_unselect_all          (GtkIconView *icon_view);

Unselects all the icons.

Since 2.6

gtk_icon_view_item_activated ()

void                gtk_icon_view_item_activated        (GtkIconView *icon_view,
                                                         GtkTreePath *path);

Activates the item determined by path.

Since 2.6

gtk_icon_view_scroll_to_path ()

void                gtk_icon_view_scroll_to_path        (GtkIconView *icon_view,
                                                         GtkTreePath *path,
                                                         gboolean use_align,
                                                         gfloat row_align,
                                                         gfloat col_align);

Moves the alignments of icon_view to the position specified by path. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

If use_align is FALSE, then the alignment arguments are ignored, and the tree does the minimum amount of work to scroll the item onto the screen. This means that the item will be scrolled to the edge closest to its current position. If the item is currently visible on the screen, nothing is done.

This function only works if the model is set, and path is a valid row on the model. If the model changes before the icon_view is realized, the centered path will be modified to reflect this change.

Since 2.8

gtk_icon_view_get_visible_range ()

gboolean            gtk_icon_view_get_visible_range     (GtkIconView *icon_view,
                                                         GtkTreePath **start_path,
                                                         GtkTreePath **end_path);

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

Both paths should be freed with gtk_tree_path_free() after use.

Since 2.8

gtk_icon_view_set_tooltip_item ()

void                gtk_icon_view_set_tooltip_item      (GtkIconView *icon_view,
                                                         GtkTooltip *tooltip,
                                                         GtkTreePath *path);

Sets the tip area of tooltip to be the area covered by the item at path. See also gtk_tooltip_set_tip_area().

Since 2.12

gtk_icon_view_set_tooltip_cell ()

void                gtk_icon_view_set_tooltip_cell      (GtkIconView *icon_view,
                                                         GtkTooltip *tooltip,
                                                         GtkTreePath *path,
                                                         GtkCellRenderer *cell);

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

Since 2.12

gtk_icon_view_get_tooltip_context ()

gboolean            gtk_icon_view_get_tooltip_context   (GtkIconView *icon_view,
                                                         gint *x,
                                                         gint *y,
                                                         gboolean keyboard_tip,
                                                         GtkTreeModel **model,
                                                         GtkTreePath **path,
                                                         GtkTreeIter *iter);

This function is supposed to be used in a "query-tooltip" signal handler for GtkIconView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.

The return value indicates whether there is an icon view item at the given coordinates (TRUE) or not (FALSE) for mouse tooltips. For keyboard tooltips the item returned will be the cursor item. When TRUE, then any of model, path and iter which have been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to icon_view's bin_window if keyboard_tooltip is FALSE.

Since 2.12

gtk_icon_view_set_tooltip_column ()

void                gtk_icon_view_set_tooltip_column    (GtkIconView *icon_view,
                                                         gint column);

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.

When enabled, "has-tooltip" will be set to TRUE and icon_view will connect a "query-tooltip" signal handler.

Since 2.12

gtk_icon_view_get_tooltip_column ()

gint                gtk_icon_view_get_tooltip_column    (GtkIconView *icon_view);

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

Since 2.12

enum GtkIconViewDropPosition

typedef enum
{
  GTK_ICON_VIEW_NO_DROP,
  GTK_ICON_VIEW_DROP_INTO,
  GTK_ICON_VIEW_DROP_LEFT,
  GTK_ICON_VIEW_DROP_RIGHT,
  GTK_ICON_VIEW_DROP_ABOVE,
  GTK_ICON_VIEW_DROP_BELOW
} GtkIconViewDropPosition;

An enum for determining where a dropped item goes.

gtk_icon_view_enable_model_drag_source ()

void                gtk_icon_view_enable_model_drag_source
                                                        (GtkIconView *icon_view,
                                                         GdkModifierType start_button_mask,
                                                         const GtkTargetEntry *targets,
                                                         gint n_targets,
                                                         GdkDragAction actions);

Turns icon_view into a drag source for automatic DND.

Since 2.8

gtk_icon_view_enable_model_drag_dest ()

void                gtk_icon_view_enable_model_drag_dest
                                                        (GtkIconView *icon_view,
                                                         const GtkTargetEntry *targets,
                                                         gint n_targets,
                                                         GdkDragAction actions);

Turns icon_view into a drop destination for automatic DND.

Since 2.8

gtk_icon_view_unset_model_drag_source ()

void                gtk_icon_view_unset_model_drag_source
                                                        (GtkIconView *icon_view);

Undoes the effect of gtk_icon_view_enable_model_drag_source().

Since 2.8

gtk_icon_view_unset_model_drag_dest ()

void                gtk_icon_view_unset_model_drag_dest (GtkIconView *icon_view);

Undoes the effect of gtk_icon_view_enable_model_drag_dest().

Since 2.8

gtk_icon_view_set_reorderable ()

void                gtk_icon_view_set_reorderable       (GtkIconView *icon_view,
                                                         gboolean reorderable);

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.

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

gtk_icon_view_get_reorderable ()

gboolean            gtk_icon_view_get_reorderable       (GtkIconView *icon_view);

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

Since 2.8

gtk_icon_view_set_drag_dest_item ()

void                gtk_icon_view_set_drag_dest_item    (GtkIconView *icon_view,
                                                         GtkTreePath *path,
                                                         GtkIconViewDropPosition pos);

Sets the item that is highlighted for feedback.

Since 2.8

gtk_icon_view_get_drag_dest_item ()

void                gtk_icon_view_get_drag_dest_item    (GtkIconView *icon_view,
                                                         GtkTreePath **path,
                                                         GtkIconViewDropPosition *pos);

Gets information about the item that is highlighted for feedback.

Since 2.8

gtk_icon_view_get_dest_item_at_pos ()

gboolean            gtk_icon_view_get_dest_item_at_pos  (GtkIconView *icon_view,
                                                         gint drag_x,
                                                         gint drag_y,
                                                         GtkTreePath **path,
                                                         GtkIconViewDropPosition *pos);

Determines the destination item for a given position.

Since 2.8

gtk_icon_view_create_drag_icon ()

GdkPixmap*          gtk_icon_view_create_drag_icon      (GtkIconView *icon_view,
                                                         GtkTreePath *path);

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

Since 2.8

The "column-spacing" property

  "column-spacing"           gint                  : Read / Write

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

Allowed values: >= 0

Default value: 6

Since 2.6

The "columns" property

  "columns"                  gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "item-width" property

  "item-width"               gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "margin" property

  "margin"                   gint                  : Read / Write

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

Allowed values: >= 0

Default value: 6

Since 2.6

The "markup-column" property

  "markup-column"            gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "model" property

  "model"                    GtkTreeModel*         : Read / Write

The model for the icon view.

The "orientation" property

  "orientation"              GtkOrientation        : Read / Write

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

Default value: GTK_ORIENTATION_VERTICAL

Since 2.6

The "pixbuf-column" property

  "pixbuf-column"            gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "reorderable" property

  "reorderable"              gboolean              : Read / Write

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

Default value: FALSE

Since 2.8

The "row-spacing" property

  "row-spacing"              gint                  : Read / Write

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

Allowed values: >= 0

Default value: 6

Since 2.6

The "selection-mode" property

  "selection-mode"           GtkSelectionMode      : Read / Write

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.

Default value: GTK_SELECTION_SINGLE

Since 2.6

The "spacing" property

  "spacing"                  gint                  : Read / Write

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

Allowed values: >= 0

Default value: 0

Since 2.6

The "text-column" property

  "text-column"              gint                  : Read / Write

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.

Allowed values: >= -1

Default value: -1

Since 2.6

The "tooltip-column" property

  "tooltip-column"           gint                  : Read / Write

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

Allowed values: >= -1

Default value: -1

The "selection-box-alpha" style property

  "selection-box-alpha"      guchar                : Read

Opacity of the selection box.

Default value: 64

The "selection-box-color" style property

  "selection-box-color"      GdkColor*             : Read

Color of the selection box.

The "activate-cursor-item" signal

gboolean            user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run Last / Action

The "item-activated" signal

void                user_function                      (GtkIconView *iconview,
                                                        GtkTreePath *arg1,
                                                        gpointer     user_data)      : Run Last

The "move-cursor" signal

gboolean            user_function                      (GtkIconView    *iconview,
                                                        GtkMovementStep arg1,
                                                        gint            arg2,
                                                        gpointer        user_data)      : Run Last / Action

The "select-all" signal

void                user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run Last / Action

The "select-cursor-item" signal

void                user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run Last / Action

The "selection-changed" signal

void                user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run First

The "set-scroll-adjustments" signal

void                user_function                      (GtkIconView   *iconview,
                                                        GtkAdjustment *arg1,
                                                        GtkAdjustment *arg2,
                                                        gpointer       user_data)      : Run Last

The "toggle-cursor-item" signal

void                user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run Last / Action

The "unselect-all" signal

void                user_function                      (GtkIconView *iconview,
                                                        gpointer     user_data)      : Run Last / Action