Top | ![]() |
![]() |
![]() |
![]() |
int | column-spacing | Read / Write |
int | columns | Read / Write |
gboolean | enable-search | Read / Write |
int | icon-column | Read / Write |
int | item-width | Read / Write |
ExoIconViewLayoutMode | layout-mode | Read / Write |
int | margin | Read / Write |
int | markup-column | Read / Write |
GtkTreeModel * | model | Read / Write |
GtkOrientation | orientation | Read / Write |
int | pixbuf-column | Read / Write |
gboolean | reorderable | Read / Write |
int | row-spacing | Read / Write |
int | search-column | Read / Write |
GtkSelectionMode | selection-mode | Read / Write |
gboolean | single-click | Read / Write |
guint | single-click-timeout | Read / Write |
int | spacing | Read / Write |
int | text-column | Read / Write |
gboolean | activate-cursor-item | Action |
void | item-activated | Run Last |
gboolean | move-cursor | Action |
void | select-all | Action |
void | select-cursor-item | Action |
void | selection-changed | Run First |
gboolean | start-interactive-search | Action |
void | toggle-cursor-item | Action |
void | unselect-all | Action |
ExoIconView implements AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkScrollable.
ExoIconView provides an alternative view on a list model.
It displays the model as a grid of icons with labels. Like
GtkTreeView, it allows to select one or multiple items
(depending on the selection mode, see exo_icon_view_set_selection_mode()
).
In addition to selection with the arrow keys, ExoIconView supports
rubberband selection, which is controlled by dragging the pointer.
GtkWidget *
exo_icon_view_new (void
);
exo_icon_view_new
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_new instead.
Creates a new ExoIconView widget
GtkWidget *
exo_icon_view_new_with_model (GtkTreeModel *model
);
exo_icon_view_new_with_model
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_new_with_model instead.
Creates a new ExoIconView widget with the model model
.
GtkTreeModel *
exo_icon_view_get_model (const ExoIconView *icon_view
);
exo_icon_view_get_model
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_model instead.
Returns the model the ExoIconView is based on. Returns NULL
if the
model is unset.
void exo_icon_view_set_model (ExoIconView *icon_view
,GtkTreeModel *model
);
exo_icon_view_set_model
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_model instead.
Sets the model for a ExoIconView.
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.
GtkOrientation
exo_icon_view_get_orientation (const ExoIconView *icon_view
);
exo_icon_view_get_orientation
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_orientation instead.
Returns the value of the ::orientation property which determines whether the labels are drawn beside the icons instead of below.
Since: 0.3.1
void exo_icon_view_set_orientation (ExoIconView *icon_view
,GtkOrientation orientation
);
exo_icon_view_set_orientation
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_orientation instead.
Sets the ::orientation property which determines whether the labels are drawn beside the icons instead of below.
Since: 0.3.1
gint
exo_icon_view_get_columns (const ExoIconView *icon_view
);
exo_icon_view_get_columns
is deprecated and should not be used in newly-written code.
Returns the value of the ::columns property.
void exo_icon_view_set_columns (ExoIconView *icon_view
,gint columns
);
exo_icon_view_set_columns
is deprecated and should not be used in newly-written code.
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: 0.3.1
gint
exo_icon_view_get_item_width (const ExoIconView *icon_view
);
exo_icon_view_get_item_width
is deprecated and should not be used in newly-written code.
Returns the value of the ::item-width property.
Since: 0.3.1
void exo_icon_view_set_item_width (ExoIconView *icon_view
,gint item_width
);
exo_icon_view_set_item_width
is deprecated and should not be used in newly-written code.
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: 0.3.1
gint
exo_icon_view_get_spacing (const ExoIconView *icon_view
);
exo_icon_view_get_spacing
is deprecated and should not be used in newly-written code.
Returns the value of the ::spacing property.
Since: 0.3.1
void exo_icon_view_set_spacing (ExoIconView *icon_view
,gint spacing
);
exo_icon_view_set_spacing
is deprecated and should not be used in newly-written code.
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: 0.3.1
gint
exo_icon_view_get_row_spacing (const ExoIconView *icon_view
);
exo_icon_view_get_row_spacing
is deprecated and should not be used in newly-written code.
Returns the value of the ::row-spacing property.
Since: 0.3.1
void exo_icon_view_set_row_spacing (ExoIconView *icon_view
,gint row_spacing
);
exo_icon_view_set_row_spacing
is deprecated and should not be used in newly-written code.
Sets the ::row-spacing property which specifies the space which is inserted between the rows of the icon view.
Since: 0.3.1
gint
exo_icon_view_get_column_spacing (const ExoIconView *icon_view
);
exo_icon_view_get_column_spacing
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_column_spacing instead.
Returns the value of the ::column-spacing property.
Since: 0.3.1
void exo_icon_view_set_column_spacing (ExoIconView *icon_view
,gint column_spacing
);
exo_icon_view_set_column_spacing
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_column_spacing instead.
Sets the ::column-spacing property which specifies the space which is inserted between the columns of the icon view.
Since: 0.3.1
gint
exo_icon_view_get_margin (const ExoIconView *icon_view
);
exo_icon_view_get_margin
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_margin instead.
Returns the value of the ::margin property.
Since: 0.3.1
void exo_icon_view_set_margin (ExoIconView *icon_view
,gint margin
);
exo_icon_view_set_margin
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_margin instead.
Sets the ::margin property which specifies the space which is inserted at the top, bottom, left and right of the icon view.
Since: 0.3.1
GtkSelectionMode
exo_icon_view_get_selection_mode (const ExoIconView *icon_view
);
exo_icon_view_get_selection_mode
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_selection_mode instead.
Gets the selection mode of the icon_view
.
void exo_icon_view_set_selection_mode (ExoIconView *icon_view
,GtkSelectionMode mode
);
exo_icon_view_set_selection_mode
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_selection_mode instead.
Sets the selection mode of the icon_view
.
ExoIconViewLayoutMode
exo_icon_view_get_layout_mode (const ExoIconView *icon_view
);
exo_icon_view_get_layout_mode
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_layout_mode instead.
Returns the ExoIconViewLayoutMode used to layout the
items in the icon_view
.
Since: 0.3.1.5
void exo_icon_view_set_layout_mode (ExoIconView *icon_view
,ExoIconViewLayoutMode layout_mode
);
exo_icon_view_set_layout_mode
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_layout_mode instead.
Sets the layout mode of icon_view
to layout_mode
.
Since: 0.3.1.5
gboolean
exo_icon_view_get_single_click (const ExoIconView *icon_view
);
exo_icon_view_get_single_click
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_single_click instead.
Returns TRUE
if icon_view
is currently in single click mode,
else FALSE
will be returned.
Since: 0.3.1.3
void exo_icon_view_set_single_click (ExoIconView *icon_view
,gboolean single_click
);
exo_icon_view_set_single_click
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_single_click instead.
If single_click
is TRUE
, icon_view
will be in single click mode
afterwards, else icon_view
will be in double click mode.
icon_view |
a ExoIconView. |
|
single_click |
|
Since: 0.3.1.3
guint
exo_icon_view_get_single_click_timeout
(const ExoIconView *icon_view
);
exo_icon_view_get_single_click_timeout
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_single_click_timeout instead.
Returns the amount of time in milliseconds after which the
item under the mouse cursor will be selected automatically
in single click mode. A value of 0
means that the behavior
is disabled and the user must alter the selection manually.
Since: 0.3.1.5
void exo_icon_view_set_single_click_timeout (ExoIconView *icon_view
,guint single_click_timeout
);
exo_icon_view_set_single_click_timeout
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_single_click_timeout instead.
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.
A value of 0
for single_click_timeout
disables the autoselection
for icon_view
.
This setting does not have any effect unless the icon_view
is in
single-click mode, see exo_icon_view_set_single_click()
.
Since: 0.3.1.5
void exo_icon_view_widget_to_icon_coords (const ExoIconView *icon_view
,gint wx
,gint wy
,gint *ix
,gint *iy
);
exo_icon_view_widget_to_icon_coords
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_widget_to_icon_coords instead.
Converts widget coordinates to coordinates for the icon window (the full scrollable area of the icon view).
icon_view |
a ExoIconView. |
|
wx |
widget x coordinate. |
|
wy |
widget y coordinate. |
|
ix |
return location for icon x coordinate or |
|
iy |
return location for icon y coordinate or |
void exo_icon_view_icon_to_widget_coords (const ExoIconView *icon_view
,gint ix
,gint iy
,gint *wx
,gint *wy
);
exo_icon_view_icon_to_widget_coords
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_icon_to_widget_coords instead.
Converts icon view coordinates (coordinates in full scrollable area of the icon view) to widget coordinates.
icon_view |
a ExoIconView. |
|
ix |
icon x coordinate. |
|
iy |
icon y coordinate. |
|
wx |
return location for widget x coordinate or |
|
wy |
return location for widget y coordinate or |
GtkTreePath * exo_icon_view_get_path_at_pos (const ExoIconView *icon_view
,gint x
,gint y
);
exo_icon_view_get_path_at_pos
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_path_at_pos instead.
Finds the path at the point (x
, y
), relative to widget coordinates.
See exo_icon_view_get_item_at_pos()
, if you are also interested in
the cell at the specified position.
icon_view |
A ExoIconView. |
|
x |
The x position to be identified |
|
y |
The y position to be identified |
gboolean exo_icon_view_get_item_at_pos (const ExoIconView *icon_view
,gint x
,gint y
,GtkTreePath **path
,GtkCellRenderer **cell
);
exo_icon_view_get_item_at_pos
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_item_at_pos instead.
Finds the path at the point (x
, y
), relative to widget coordinates.
In contrast to exo_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()
.
icon_view |
A ExoIconView. |
|
x |
The x position to be identified |
|
y |
The y position to be identified |
|
path |
Return location for the path, or |
|
cell |
Return location for the renderer responsible for the cell
at ( |
Since: 0.3.1
gboolean exo_icon_view_get_visible_range (const ExoIconView *icon_view
,GtkTreePath **start_path
,GtkTreePath **end_path
);
exo_icon_view_get_visible_range
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_visible_range instead.
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.
icon_view |
||
start_path |
Return location for start of region, or |
|
end_path |
Return location for end of region, or |
Since: 0.3.1
void (*ExoIconViewForeachFunc) (ExoIconView *icon_view
,GtkTreePath *path
,gpointer user_data
);
ExoIconViewForeachFunc
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconViewForeachFunc instead.
Callback function prototype, invoked for every selected path in the
icon_view
. See exo_icon_view_selected_foreach()
for details.
icon_view |
an ExoIconView. |
|
path |
the current path. |
|
user_data |
the user data supplied to |
void exo_icon_view_selected_foreach (ExoIconView *icon_view
,ExoIconViewForeachFunc func
,gpointer data
);
exo_icon_view_selected_foreach
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_selected_foreach instead.
Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function.
icon_view |
A ExoIconView. |
|
func |
The funcion to call for each selected icon. |
|
data |
User data to pass to the function. |
void exo_icon_view_select_path (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_select_path
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_select_path instead.
Selects the row at path
.
void exo_icon_view_unselect_path (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_unselect_path
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_unselect_path instead.
Unselects the row at path
.
gboolean exo_icon_view_path_is_selected (const ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_path_is_selected
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_path_is_selected instead.
Returns TRUE
if the icon pointed to by path
is currently
selected. If icon
does not point to a valid location, FALSE
is returned.
gint exo_icon_view_get_item_column (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_get_item_column
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_item_column instead.
Gets the column in which the item path
is currently
displayed. Column numbers start at 0.
Since: 0.7.1
gint exo_icon_view_get_item_row (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_get_item_row
is deprecated and should not be used in newly-written code.
Gets the row in which the item path
is currently
displayed. Row numbers start at 0.
Since: 0.7.1
GList *
exo_icon_view_get_selected_items (const ExoIconView *icon_view
);
exo_icon_view_get_selected_items
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_selected_items instead.
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:
1 2 |
g_list_foreach (list, gtk_tree_path_free, NULL); g_list_free (list); |
void
exo_icon_view_select_all (ExoIconView *icon_view
);
exo_icon_view_select_all
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_select_all instead.
Selects all the icons. icon_view
must has its selection mode set
to GTK_SELECTION_MULTIPLE.
void
exo_icon_view_unselect_all (ExoIconView *icon_view
);
exo_icon_view_unselect_all
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_unselect_all instead.
Unselects all the icons.
void
exo_icon_view_selection_invert (ExoIconView *icon_view
);
exo_icon_view_selection_invert
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_selection_invert instead.
Selects all the icons that are currently not selected. icon_view
must
has its selection mode set to GTK_SELECTION_MULTIPLE.
void exo_icon_view_item_activated (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_item_activated
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_item_activated instead.
Activates the item determined by path
.
gboolean exo_icon_view_get_cursor (const ExoIconView *icon_view
,GtkTreePath **path
,GtkCellRenderer **cell
);
exo_icon_view_get_cursor
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_cursor instead.
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()
.
icon_view |
||
path |
Return location for the current cursor path, or |
|
cell |
Return location the current focus cell, or |
Since: 0.3.1
void exo_icon_view_set_cursor (ExoIconView *icon_view
,GtkTreePath *path
,GtkCellRenderer *cell
,gboolean start_editing
);
exo_icon_view_set_cursor
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_cursor instead.
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.
icon_view |
||
path |
a GtkTreePath |
|
cell |
a GtkCellRenderer or |
|
start_editing |
|
Since: 0.3.1
void exo_icon_view_scroll_to_path (ExoIconView *icon_view
,GtkTreePath *path
,gboolean use_align
,gfloat row_align
,gfloat col_align
);
exo_icon_view_scroll_to_path
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_scroll_to_path instead.
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 tree_view
is realized, the centered
path will be modified to reflect this change.
icon_view |
A ExoIconView. |
|
path |
The path of the item to move to. |
|
use_align |
whether to use alignment arguments, or |
|
row_align |
The vertical alignment of the item specified by |
|
col_align |
The horizontal alignment of the item specified by |
Since: 0.3.1
void exo_icon_view_enable_model_drag_source (ExoIconView *icon_view
,GdkModifierType start_button_mask
,const GtkTargetEntry *targets
,gint n_targets
,GdkDragAction actions
);
exo_icon_view_enable_model_drag_source
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_enable_model_drag_source instead.
Turns icon_view
into a drag source for automatic DND.
icon_view |
a GtkIconTreeView |
|
start_button_mask |
Mask of allowed buttons to start drag |
|
targets |
the table of targets that the drag will support |
|
n_targets |
the number of items in |
|
actions |
the bitmask of possible actions for a drag from this widget |
Since: 0.3.1
void exo_icon_view_enable_model_drag_dest (ExoIconView *icon_view
,const GtkTargetEntry *targets
,gint n_targets
,GdkDragAction actions
);
exo_icon_view_enable_model_drag_dest
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_enable_model_drag_dest instead.
Turns icon_view
into a drop destination for automatic DND.
icon_view |
||
targets |
the table of targets that the drag will support |
|
n_targets |
the number of items in |
|
actions |
the bitmask of possible actions for a drag from this widget |
Since: 0.3.1
void
exo_icon_view_unset_model_drag_source (ExoIconView *icon_view
);
exo_icon_view_unset_model_drag_source
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_unset_model_drag_source instead.
Undoes the effect of exo_icon_view_enable_model_drag_source()
.
Since: 0.3.1
void
exo_icon_view_unset_model_drag_dest (ExoIconView *icon_view
);
exo_icon_view_unset_model_drag_dest
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_unset_model_drag_dest instead.
Undoes the effect of exo_icon_view_enable_model_drag_dest()
.
Since: 0.3.1
void exo_icon_view_set_reorderable (ExoIconView *icon_view
,gboolean reorderable
);
exo_icon_view_set_reorderable
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_reorderable instead.
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: 0.3.1
gboolean
exo_icon_view_get_reorderable (ExoIconView *icon_view
);
exo_icon_view_get_reorderable
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_reorderable instead.
Retrieves whether the user can reorder the list via drag-and-drop.
See exo_icon_view_set_reorderable()
.
Since: 0.3.1
void exo_icon_view_set_drag_dest_item (ExoIconView *icon_view
,GtkTreePath *path
,ExoIconViewDropPosition pos
);
exo_icon_view_set_drag_dest_item
is deprecated and should not be used in newly-written code.
Sets the item that is highlighted for feedback.
icon_view |
||
path |
The path of the item to highlight, or |
|
pos |
Specifies whether to drop, relative to the item |
Since: 0.3.1
void exo_icon_view_get_drag_dest_item (ExoIconView *icon_view
,GtkTreePath **path
,ExoIconViewDropPosition *pos
);
exo_icon_view_get_drag_dest_item
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_drag_dest_item instead.
Gets information about the item that is highlighted for feedback.
icon_view |
||
path |
Return location for the path of the highlighted item, or |
|
pos |
Return location for the drop position, or |
Since: 0.3.1
gboolean exo_icon_view_get_dest_item_at_pos (ExoIconView *icon_view
,gint drag_x
,gint drag_y
,GtkTreePath **path
,ExoIconViewDropPosition *pos
);
exo_icon_view_get_dest_item_at_pos
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_dest_item_at_pos instead.
Determines the destination item for a given position.
Both drag_x
and drag_y
are given in icon window coordinates. Use
exo_icon_view_widget_to_icon_coords()
if you need to translate
widget coordinates first.
icon_view |
||
drag_x |
the position to determine the destination item for |
|
drag_y |
the position to determine the destination item for |
|
path |
Return location for the path of the highlighted item, or |
|
pos |
Return location for the drop position, or |
Since: 0.3.1
cairo_surface_t * exo_icon_view_create_drag_icon (ExoIconView *icon_view
,GtkTreePath *path
);
exo_icon_view_create_drag_icon
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_create_drag_icon instead.
Creates a cairo_surface_t representation of the item at path
.
This image is used for a drag icon.
Since: 0.3.1
gboolean (*ExoIconViewSearchEqualFunc) (GtkTreeModel *model
,gint column
,const gchar *key
,GtkTreeIter *iter
,gpointer search_data
);
ExoIconViewSearchEqualFunc
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconViewSearchEqualFunc instead.
A function used for checking whether a row in model
matches a search key string
entered by the user. Note the return value is reversed from what you would normally
expect, though it has some similarity to strcmp()
returning 0 for equal strings.
model |
the GtkTreeModel being searched. |
|
column |
the search column set by |
|
key |
the key string to compare with. |
|
iter |
the GtkTreeIter of the current item. |
|
search_data |
user data from |
void (*ExoIconViewSearchPositionFunc) (ExoIconView *icon_view
,GtkWidget *search_dialog
,gpointer user_data
);
ExoIconViewSearchPositionFunc
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconViewSearchPositionFunc instead.
A function used to place the search_dialog
for the icon_view
.
icon_view |
an ExoIconView. |
|
search_dialog |
the search dialog window to place. |
|
user_data |
user data from |
gboolean
exo_icon_view_get_enable_search (const ExoIconView *icon_view
);
exo_icon_view_get_enable_search
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_enable_search instead.
Returns whether or not the icon_view
allows to start
interactive searching by typing in text.
Since: 0.3.1.3
void exo_icon_view_set_enable_search (ExoIconView *icon_view
,gboolean enable_search
);
exo_icon_view_set_enable_search
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_enable_search instead.
If enable_search
is set, then the user can type in text to search through
the icon_view
interactively (this is sometimes called "typeahead find").
Note that even if this is FALSE
, the user can still initiate a search
using the "start-interactive-search" key binding.
Since: 0.3.1.3
gint
exo_icon_view_get_search_column (const ExoIconView *icon_view
);
exo_icon_view_get_search_column
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_search_column instead.
Returns the column searched on by the interactive search code.
Since: 0.3.1.3
void exo_icon_view_set_search_column (ExoIconView *icon_view
,gint search_column
);
exo_icon_view_set_search_column
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_search_column instead.
Sets search_column
as the column where the interactive search code should search in.
If the search column is set, user can use the "start-interactive-search" key binding to bring up search popup. The "enable-search" property controls whether simply typing text will also start an interactive search.
Note that search_column
refers to a column of the model.
icon_view |
an ExoIconView. |
|
search_column |
the column of the model to search in, or -1 to disable searching. |
Since: 0.3.1.3
ExoIconViewSearchEqualFunc
exo_icon_view_get_search_equal_func (const ExoIconView *icon_view
);
exo_icon_view_get_search_equal_func
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_search_equal_func instead.
Returns the compare function currently in use.
Since: 0.3.1.3
void exo_icon_view_set_search_equal_func (ExoIconView *icon_view
,ExoIconViewSearchEqualFunc search_equal_func
,gpointer search_equal_data
,GDestroyNotify search_equal_destroy
);
exo_icon_view_set_search_equal_func
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_search_equal_func instead.
Sets the compare function for the interactive search capabilities;
note that some like strcmp()
returning 0 for equality
ExoIconViewSearchEqualFunc returns FALSE
on matches.
Specifying NULL
for search_equal_func
will reset icon_view
to use the default
search equal function.
icon_view |
an ExoIconView. |
|
search_equal_func |
the compare function to use during the search, or |
|
search_equal_data |
user data to pass to |
|
search_equal_destroy |
destroy notifier for |
Since: 0.3.1.3
ExoIconViewSearchPositionFunc
exo_icon_view_get_search_position_func
(const ExoIconView *icon_view
);
exo_icon_view_get_search_position_func
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_get_search_position_func instead.
Returns the search dialog positioning function currently in use.
Since: 0.3.1.3
void exo_icon_view_set_search_position_func (ExoIconView *icon_view
,ExoIconViewSearchPositionFunc search_position_func
,gpointer search_position_data
,GDestroyNotify search_position_destroy
);
exo_icon_view_set_search_position_func
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use xfce_icon_view_set_search_position_func instead.
Sets the function to use when positioning the seach dialog.
Specifying NULL
for search_position_func
will reset icon_view
to use the default
search position function.
icon_view |
an ExoIconView. |
|
search_position_func |
the function to use to position the search dialog, or |
|
search_position_data |
user data to pass to |
|
search_position_destroy |
destroy notifier for |
Since: 0.3.1.3
struct ExoIconView;
ExoIconView
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconView instead.
ExoIconView provides an alternative view on a list model.
It displays the model as a grid of icons with labels. Like
GtkTreeView, it allows to select one or multiple items
(depending on the selection mode, see exo_icon_view_set_selection_mode()
).
In addition to selection with the arrow keys, ExoIconView supports
rubberband selection, which is controlled by dragging the pointer.
ExoIconViewDropPosition
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconViewDropPosition instead.
Specifies whether to display the drop indicator, i.e. where to drop into the icon view.
ExoIconViewLayoutMode
has been deprecated since version 4.21.0 and should not be used in newly-written code.
Use XfceIconViewLayoutMode instead.
Specifies the layouting mode of an ExoIconView. EXO_ICON_VIEW_LAYOUT_ROWS
is the default, which lays out items vertically in rows from top to bottom.
EXO_ICON_VIEW_LAYOUT_COLS
lays out items horizontally in columns from left
to right.
“column-spacing”
property “column-spacing” int
The column-spacing property specifies the space which is inserted between the columns of the icon view.
ExoIconView:column-spacing
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= 0
Default value: 6
Since: 0.3.1
“columns”
property “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.
ExoIconView:columns
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 0.3.1
“enable-search”
property “enable-search” gboolean
View allows user to search through columns interactively.
ExoIconView:enable-search
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: TRUE
Since: 0.3.1.3
“icon-column”
property “icon-column” int
The ::icon-column property contains the number of the model column containing an absolute path to an image file to render. The icon column must be of type G_TYPE_STRING. Setting this property to -1 turns off the display of icons.
ExoIconView:icon-column
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 0.10.2
“item-width”
property “item-width” 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.
ExoIconView:item-width
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 0.3.1
“layout-mode”
property“layout-mode” ExoIconViewLayoutMode
The layout-mode property specifies the way items are layed out in
the ExoIconView. This can be either EXO_ICON_VIEW_LAYOUT_ROWS
,
which is the default, where items are layed out horizontally in
rows from top to bottom, or EXO_ICON_VIEW_LAYOUT_COLS
, where items
are layed out vertically in columns from left to right.
ExoIconView:layout-mode
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: EXO_ICON_VIEW_LAYOUT_ROWS
Since: 0.3.1.5
“margin”
property “margin” int
The margin property specifies the space which is inserted at the edges of the icon view.
ExoIconView:margin
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= 0
Default value: 6
Since: 0.3.1
“markup-column”
property “markup-column” 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.
ExoIconView:markup-column
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“model”
property “model” GtkTreeModel *
The model property contains the GtkTreeModel, which should be
display by this icon view. Setting this property to NULL
turns
off the display of anything.
ExoIconView:model
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
“orientation”
property “orientation” GtkOrientation
The orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other.
ExoIconView:orientation
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: GTK_ORIENTATION_VERTICAL
“pixbuf-column”
property “pixbuf-column” 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.
ExoIconView:pixbuf-column
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“reorderable”
property “reorderable” gboolean
The reorderable property specifies if the items can be reordered by Drag and Drop.
ExoIconView:reorderable
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: FALSE
Since: 0.3.1
“row-spacing”
property “row-spacing” int
The row-spacing property specifies the space which is inserted between the rows of the icon view.
ExoIconView:row-spacing
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= 0
Default value: 6
Since: 0.3.1
“search-column”
property “search-column” int
Model column to search through when searching through code.
ExoIconView:search-column
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 0.3.1.3
“selection-mode”
property “selection-mode” GtkSelectionMode
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.
ExoIconView:selection-mode
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: GTK_SELECTION_SINGLE
“single-click”
property “single-click” gboolean
Determines whether items can be activated by single or double clicks.
ExoIconView:single-click
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: FALSE
Since: 0.3.1.3
“single-click-timeout”
property “single-click-timeout” guint
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. A value of 0
disables the automatic selection.
ExoIconView:single-click-timeout
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Default value: 0
Since: 0.3.1.5
“spacing”
property “spacing” int
The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.
ExoIconView:spacing
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= 0
Default value: 0
Since: 0.3.1
“text-column”
property “text-column” 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.
ExoIconView:text-column
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Owner: ExoIconView
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“activate-cursor-item”
signalgboolean user_function (ExoIconView *icon_view, gpointer user_data)
A GtkBindingSignal which gets emitted when the user activates the currently focused item.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control activation
programmatically.
The default bindings for this signal are Space, Return and Enter.
ExoIconView::activate-cursor-item
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action
“item-activated”
signalvoid user_function (ExoIconView *icon_view, GtkTreePath *path, gpointer user_data)
The ::item-activated signal is emitted when the method
exo_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.
ExoIconView::item-activated
has been deprecated since version 4.21.0. and should not be used in newly-written code.
icon_view |
a ExoIconView. |
|
path |
the GtkTreePath of the activated item. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“move-cursor”
signalgboolean user_function (ExoIconView *icon_view, GtkMovementStep step, int count, gpointer user_data)
The ::move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the cursor
programmatically.
The default bindings for this signal include
Arrow keys which move by individual steps
Home/End keys which move to the first/last item
PageUp/PageDown which move by "pages" All of these will extend the selection when combined with the Shift modifier.
ExoIconView::move-cursor
has been deprecated since version 4.21.0. and should not be used in newly-written code.
icon_view |
a ExoIconView. |
|
step |
the granularity of the move, as a GtkMovementStep |
|
count |
the number of |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“select-all”
signalvoid user_function (ExoIconView *icon_view, gpointer user_data)
A GtkBindingSignal which gets emitted when the user selects all items.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection
programmatically.
The default binding for this signal is Ctrl-a.
ExoIconView::select-all
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action
“select-cursor-item”
signalvoid user_function (ExoIconView *icon_view, gpointer user_data)
A GtkBindingSignal which gets emitted when the user selects the item that is currently focused.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection
programmatically.
There is no default binding for this signal.
ExoIconView::select-cursor-item
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action
“selection-changed”
signalvoid user_function (ExoIconView *icon_view, gpointer user_data)
The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes.
ExoIconView::selection-changed
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Run First
“start-interactive-search”
signalgboolean user_function (ExoIconView *icon_view, gpointer user_data)
The ::start-interative-search signal is emitted when the user starts typing to jump to an item in the icon view.
ExoIconView::start-interactive-search
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action
“toggle-cursor-item”
signalvoid user_function (ExoIconView *icon_view, gpointer user_data)
A GtkBindingSignal 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.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection
programmatically.
There is no default binding for this signal is Ctrl-Space.
ExoIconView::toggle-cursor-item
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action
“unselect-all”
signalvoid user_function (ExoIconView *icon_view, gpointer user_data)
A GtkBindingSignal which gets emitted when the user unselects all items.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control selection
programmatically.
The default binding for this signal is Ctrl-Shift-a.
ExoIconView::unselect-all
has been deprecated since version 4.21.0. and should not be used in newly-written code.
Flags: Action