GtkIconView

typedef struct _GtkIconView GtkIconView;

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

GtkIconViewPrivate

typedef struct _GtkIconViewPrivate GtkIconViewPrivate;

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 widget coordinates.

Since 2.6

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);

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 icon 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

The "column-spacing" property

  "column-spacing"       gint                  : Read / Write

Space which is inserted between grid column.

Allowed values: >= 0

Default value: 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 width used for each item.

Allowed values: >= -1

Default value: -1

The "margin" property

  "margin"               gint                  : Read / Write

Space which is inserted at the edges of the icon view.

Allowed values: >= 0

Default value: 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

How the text and icon of each item are positioned relative to each other.

Default value: GTK_ORIENTATION_VERTICAL

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 "row-spacing" property

  "row-spacing"          gint                  : Read / Write

Space which is inserted between grid rows.

Allowed values: >= 0

Default value: 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

Space which is inserted between cells of an item.

Allowed values: >= 0

Default value: 0

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 "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);

The "item-activated" signal

void        user_function                  (GtkIconView *iconview,
                                            GtkTreePath *arg1,
                                            gpointer user_data);

The "move-cursor" signal

gboolean    user_function                  (GtkIconView *iconview,
                                            GtkMovementStep arg1,
                                            gint arg2,
                                            gpointer user_data);

The "select-all" signal

void        user_function                  (GtkIconView *iconview,
                                            gpointer user_data);

The "select-cursor-item" signal

void        user_function                  (GtkIconView *iconview,
                                            gpointer user_data);

The "selection-changed" signal

void        user_function                  (GtkIconView *iconview,
                                            gpointer user_data);

The "set-scroll-adjustments" signal

void        user_function                  (GtkIconView *iconview,
                                            GtkAdjustment *arg1,
                                            GtkAdjustment *arg2,
                                            gpointer user_data);

The "toggle-cursor-item" signal

void        user_function                  (GtkIconView *iconview,
                                            gpointer user_data);

The "unselect-all" signal

void        user_function                  (GtkIconView *iconview,
                                            gpointer user_data);