IconView provides an alternative view on a list model.
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
set_selection_mode). In addition to selection with the arrow keys, IconView supports rubberband
selection, which is controlled by dragging the pointer.
- public int column_spacing { get; set; }
The column-spacing property specifies the space which is inserted
between the columns of the icon view.
- public int columns { get; set; }
The columns property contains the number of the columns in which the
items should be displayed.
- public bool enable_search { get; set; }
View allows user to search through columns interactively.
- public int icon_column { get; set; }
The XfceIconView::icon-column property contains the
number of the model column containing an absolute path to an image file to render.
- public int item_width { get; set; }
The item-width property specifies the width to use for each item.
- public IconViewLayoutMode layout_mode { get; set; }
The layout-mode property specifies the way items are layed out in the
IconView.
- public int margin { get; set; }
- public int markup_column { get; set; }
The markup-column property contains the number of the model column
containing markup information to be displayed.
- public TreeModel model { get; set; }
The model property contains the
TreeModel, which should be display by this icon view.
- public Orientation orientation { get; set; }
The orientation property specifies how the cells (i.
- public int pixbuf_column { get; set; }
The XfceIconView::pixbuf-column property contains the
number of the model column containing the pixbufs which are displayed.
- public bool reorderable { get; set; }
The reorderable property specifies if the items can be reordered by
Drag and Drop.
- public int row_spacing { get; set; }
The row-spacing property specifies the space which is inserted between
the rows of the icon view.
- public int search_column { get; set; }
Model column to search through when searching through code.
- public SelectionMode selection_mode { get; set; }
The selection-mode property specifies the selection mode of icon view.
- public bool single_click { get; set; }
Determines whether items can be activated by single or double clicks.
- public uint single_click_timeout { get; set; }
The amount of time in milliseconds after which a prelited item (an
item which is hovered by the mouse cursor) will be selected automatically in single click mode.
- public int spacing { get; set; }
The spacing property specifies the space which is inserted between the
cells (i.
- public int text_column { get; set; }
The text-column property contains the number of the model column
containing the texts which are displayed.
- public Surface create_drag_icon (TreePath path)
Creates a
XlibSurface representation of the item at path.
- public void enable_model_drag_dest (TargetEntry targets, int n_targets, DragAction actions)
Turns this into a drop destination
for automatic DND.
- public void enable_model_drag_source (ModifierType start_button_mask, TargetEntry targets, int n_targets, DragAction actions)
Turns this into a drag source for
automatic DND.
- public bool get_cell_area (TreePath path, CellRenderer cell, out Rectangle cell_area)
Fills the cell_area rectangle with the size and position
of the cell specified by path and cell, relative to the icon window coordinates.
- public int get_column_spacing ()
Returns the value of the XfceIconView::column-spacing
property.
- public int get_columns ()
Returns the value of the XfceIconView::columnss property.
- public bool get_cursor (TreePath path, CellRenderer cell)
Fills in path and cell with the current
cursor path and cell.
- public bool get_dest_item_at_pos (int drag_x, int drag_y, TreePath path, IconViewDropPosition pos)
Determines the destination item for a given position.
- public void get_drag_dest_item (TreePath path, IconViewDropPosition pos)
Gets information about the item that is highlighted for feedback.
- public bool get_enable_search ()
Returns whether or not the this
allows to start interactive searching by typing in text.
- public bool get_item_at_pos (int x, int y, TreePath path, CellRenderer cell)
Finds the path at the point (x, y), relative
to widget coordinates.
- public int get_item_column (TreePath path)
Gets the column in which the item path is currently
displayed.
- public int get_item_row (TreePath path)
Gets the row in which the item path is currently
displayed.
- public int get_item_width ()
Returns the value of the XfceIconView::item-width
property.
- public IconViewLayoutMode get_layout_mode ()
- public int get_margin ()
Returns the value of the XfceIconView::margin property.
- public unowned TreeModel? get_model ()
Returns the model the IconView is based on.
- public Orientation get_orientation ()
Returns the value of the XfceIconView::orientation
property which determines whether the labels are drawn beside the icons instead of below.
- public TreePath? get_path_at_pos (int x, int y)
Finds the path at the point (x, y), relative
to widget coordinates.
- public bool get_reorderable ()
Retrieves whether the user can reorder the list via drag-and-drop.
- public int get_row_spacing ()
Returns the value of the XfceIconView::row-spacing
property.
- public int get_search_column ()
Returns the column searched on by the interactive search code.
- public unowned IconViewSearchEqualFunc get_search_equal_func ()
Returns the compare function currently in use.
- public unowned IconViewSearchPositionFunc get_search_position_func ()
Returns the search dialog positioning function currently in use.
- public List<TreePath> get_selected_items ()
Creates a list of paths of all selected items.
- public SelectionMode get_selection_mode ()
Gets the selection mode of the this.
- public bool get_single_click ()
Returns true if
this is currently in single click mode, else false will be
returned.
- public uint get_single_click_timeout ()
Returns the amount of time in milliseconds after which the item under
the mouse cursor will be selected automatically in single click mode.
- public int get_spacing ()
Returns the value of the XfceIconView::spacing property.
- public bool get_visible_range (TreePath start_path, TreePath end_path)
Sets start_path and end_path to be the first
and last visible path.
- public void icon_to_widget_coords (int ix, int iy, int wx, int wy)
Converts icon view coordinates (coordinates in full scrollable area of
the icon view) to widget coordinates.
- public bool path_is_selected (TreePath path)
Returns true if the icon pointed to
by path is currently selected.
- public void scroll_to_path (TreePath path, bool use_align, float row_align, float col_align)
Moves the alignments of this to the
position specified by path.
- public void select_path (TreePath path)
Selects the row at path.
- public void selected_foreach (IconViewForeachFunc func)
Calls a function for each selected icon.
- public void selection_invert ()
Selects all the icons that are currently not selected.
- public void set_column_spacing (int column_spacing)
Sets the XfceIconView::column-spacing property which
specifies the space which is inserted between the columns of the icon view.
- public void set_columns (int columns)
Sets the XfceIconView::columnss property which determines
in how many columns the icons are arranged.
- public void set_cursor (TreePath path, CellRenderer cell, bool start_editing)
Sets the current keyboard focus to be at path, and
selects it.
- public void set_drag_dest_item (TreePath path, IconViewDropPosition pos)
Sets the item that is highlighted for feedback.
- public void set_enable_search (bool enable_search)
If enable_search is set, then the user can type in text
to search through the this interactively (this is sometimes called "typeahead find").
- public void set_item_width (int item_width)
Sets the XfceIconView::item-width property which
specifies the width to use for each item.
- public void set_layout_mode (IconViewLayoutMode layout_mode)
Sets the layout mode of this to
layout_mode.
- public void set_margin (int margin)
Sets the XfceIconView::margin property which specifies
the space which is inserted at the top, bottom, left and right of the icon view.
- public void set_model (TreeModel model)
Sets the model for a IconView.
- public void set_orientation (Orientation orientation)
Sets the XfceIconView::orientation property which
determines whether the labels are drawn beside the icons instead of below.
- public void set_reorderable (bool reorderable)
- public void set_row_spacing (int row_spacing)
Sets the XfceIconView::row-spacing property which
specifies the space which is inserted between the rows of the icon view.
- public virtual void set_scroll_adjustments (Adjustment hadjustment, Adjustment vadjustment)
- public void set_search_column (int search_column)
Sets search_column as the column where the interactive
search code should search in.
- public void set_search_equal_func (owned IconViewSearchEqualFunc search_equal_func)
Sets the compare function for the interactive search capabilities;
note that some like strcmp returning 0 for equality
IconViewSearchEqualFunc returns false on matches.
- public void set_search_position_func (owned IconViewSearchPositionFunc search_position_func)
Sets the function to use when positioning the seach dialog.
- public void set_selection_mode (SelectionMode mode)
Sets the selection mode of the this.
- public void set_single_click (bool single_click)
If single_click is true
, this will be in single click mode afterwards, else this will be
in double click mode.
- public void set_single_click_timeout (uint single_click_timeout)
If single_click_timeout is a value greater than zero, it
specifies the amount of time in milliseconds after which the item under the mouse cursor will be selected automatically in single
click mode.
- public void set_spacing (int spacing)
Sets the XfceIconView::spacing property which specifies
the space which is inserted between the cells (i.
- public void unselect_path (TreePath path)
Unselects the row at path.
- public void unset_model_drag_dest ()
- public void unset_model_drag_source ()
- public void widget_to_icon_coords (int wx, int wy, int ix, int iy)
Converts widget coordinates to coordinates for the icon window (the
full scrollable area of the icon view).