Class
GtkIconView
Description [src]
class Gtk.IconView : Gtk.Container
implements Atk.ImplementorIface, Gtk.Buildable, Gtk.CellLayout, Gtk.Scrollable {
/* No available fields */
}
GtkIconView
provides an alternative view on a GtkTreeModel
.
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 gtk_icon_view_set_selection_mode()).
In addition to selection with the arrow keys, GtkIconView
supports
rubberband selection, which is controlled by dragging the pointer.
Note that if the tree model is backed by an actual tree store (as
opposed to a flat list where the mapping to icons is obvious),
GtkIconView
will only display the first level of the tree and
ignore the tree’s branches.
CSS nodes
iconview.view
╰── [rubberband]
GtkIconView has a single CSS node with name iconview and style class .view. For rubberband selection, a subnode with name rubberband is used.
Constructors
gtk_icon_view_new_with_area
Creates a new GtkIconView
widget using the
specified area
to layout cells inside the icons.
since: 3.0
Instance methods
gtk_icon_view_convert_widget_to_bin_window_coords
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_create_drag_icon
Creates a #cairo_surface_t representation of the item at path
.
This image is used for a drag icon.
since: 2.8
gtk_icon_view_enable_model_drag_dest
Turns icon_view
into a drop destination for automatic DND. Calling this
method sets GtkIconView:reorderable
to FALSE
.
since: 2.8
gtk_icon_view_enable_model_drag_source
Turns icon_view
into a drag source for automatic DND. Calling this
method sets GtkIconView:reorderable
to FALSE
.
since: 2.8
gtk_icon_view_get_activate_on_single_click
Gets the setting set by gtk_icon_view_set_activate_on_single_click().
since: 3.8
gtk_icon_view_get_cell_rect
Fills the bounding rectangle in widget coordinates for the cell specified by
path
and cell
. If cell
is NULL
the main cell area is used.
since: 3.6
gtk_icon_view_get_cursor
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
.
since: 2.8
gtk_icon_view_get_drag_dest_item
Gets information about the item that is highlighted for feedback.
since: 2.8
gtk_icon_view_get_item_at_pos
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_get_item_column
Gets the column in which the item path
is currently
displayed. Column numbers start at 0.
since: 2.22
gtk_icon_view_get_item_orientation
Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.
since: 2.6
gtk_icon_view_get_item_row
Gets the row in which the item path
is currently
displayed. Row numbers start at 0.
since: 2.22
gtk_icon_view_get_model
Returns the model the GtkIconView
is based on. Returns NULL
if the
model is unset.
since: 2.6
gtk_icon_view_get_path_at_pos
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_reorderable
Retrieves whether the user can reorder the list via drag-and-drop. See gtk_icon_view_set_reorderable().
since: 2.8
gtk_icon_view_get_selected_items
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().
since: 2.6
gtk_icon_view_get_tooltip_column
Returns the column of icon_view
’s model which is being used for
displaying tooltips on icon_view
’s rows.
since: 2.12
gtk_icon_view_get_tooltip_context
This function is supposed to be used in a GtkWidget::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.
since: 2.12
gtk_icon_view_get_visible_range
Sets start_path
and end_path
to be the first and last visible path.
Note that there may be invisible paths in between.
since: 2.8
gtk_icon_view_path_is_selected
Returns TRUE
if the icon pointed to by path
is currently
selected. If path
does not point to a valid location, FALSE
is returned.
since: 2.6
gtk_icon_view_scroll_to_path
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.
since: 2.8
gtk_icon_view_select_all
Selects all the icons. icon_view
must has its selection mode set
to #GTK_SELECTION_MULTIPLE.
since: 2.6
gtk_icon_view_selected_foreach
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_activate_on_single_click
Causes the GtkIconView::item-activated
signal to be emitted on
a single click instead of a double click.
since: 3.8
gtk_icon_view_set_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_set_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_set_cursor
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.
since: 2.8
gtk_icon_view_set_item_orientation
Sets the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.
since: 2.6
gtk_icon_view_set_item_padding
Sets the GtkIconView:item-padding
property which specifies the padding
around each of the icon view’s items.
since: 2.18
gtk_icon_view_set_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_set_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_set_markup_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_set_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_set_pixbuf_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_set_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. The reordering is implemented by setting up
the icon view as a drag source and destination. Therefore, drag and
drop can not be used in a reorderable view for any other purpose.
since: 2.8
gtk_icon_view_set_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_set_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_set_text_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_set_tooltip_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_set_tooltip_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.
since: 2.12
gtk_icon_view_set_tooltip_item
Sets the tip area of tooltip
to be the area covered by the item at path
.
See also gtk_icon_view_set_tooltip_column()
for a simpler alternative.
See also gtk_tooltip_set_tip_area().
since: 2.12
gtk_icon_view_unset_model_drag_dest
Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this
method sets GtkIconView:reorderable
to FALSE
.
since: 2.8
gtk_icon_view_unset_model_drag_source
Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this
method sets GtkIconView:reorderable
to FALSE
.
since: 2.8
Methods inherited from GtkContainer (33)
Please see GtkContainer for a full list of methods.
Methods inherited from GtkBuildable (10)
gtk_buildable_add_child
Adds a child to buildable
. type
is an optional string
describing how the child should be added.
since: 2.12
gtk_buildable_construct_child
Constructs a child of buildable
with the name name
.
since: 2.12
gtk_buildable_custom_finished
This is similar to gtk_buildable_parser_finished()
but is
called once for each custom tag handled by the buildable
.
since: 2.12
gtk_buildable_custom_tag_end
This is called at the end of each custom element handled by the buildable.
since: 2.12
gtk_buildable_custom_tag_start
This is called for each unknown element under <child>
.
since: 2.12
gtk_buildable_get_internal_child
Get the internal child called childname
of the buildable
object.
since: 2.12
gtk_buildable_get_name
Gets the name of the buildable
object.
since: 2.12
gtk_buildable_parser_finished
Called when the builder finishes the parsing of a
[GtkBuilder UI definition][BUILDER-UI].
Note that this will be called once for each time
gtk_builder_add_from_file()
or gtk_builder_add_from_string()
is called on a builder.
since: 2.12
gtk_buildable_set_buildable_property
Sets the property name name
to value
on the buildable
object.
since: 2.12
gtk_buildable_set_name
Sets the name of the buildable
object.
since: 2.12
Methods inherited from GtkCellLayout (10)
gtk_cell_layout_add_attribute
Adds an attribute mapping to the list in cell_layout
.
since: 2.4
gtk_cell_layout_clear
Unsets all the mappings on all renderers on cell_layout
and
removes all renderers from cell_layout
.
since: 2.4
gtk_cell_layout_clear_attributes
Clears all existing attributes previously set with gtk_cell_layout_set_attributes().
since: 2.4
gtk_cell_layout_get_area
Returns the underlying GtkCellArea
which might be cell_layout
if called on a GtkCellArea
or might be NULL
if no GtkCellArea
is used by cell_layout
.
since: 3.0
gtk_cell_layout_get_cells
Returns the cell renderers which have been added to cell_layout
.
since: 2.12
gtk_cell_layout_pack_end
Adds the cell
to the end of cell_layout
. If expand
is FALSE
, then the
cell
is allocated no more space than it needs. Any unused space is
divided evenly between cells for which expand
is TRUE
.
since: 2.4
gtk_cell_layout_pack_start
Packs the cell
into the beginning of cell_layout
. If expand
is FALSE
,
then the cell
is allocated no more space than it needs. Any unused space
is divided evenly between cells for which expand
is TRUE
.
since: 2.4
gtk_cell_layout_reorder
Re-inserts cell
at position
.
since: 2.4
gtk_cell_layout_set_attributes
Sets the attributes in list as the attributes of cell_layout
.
since: 2.4
gtk_cell_layout_set_cell_data_func
Sets the GtkCellLayoutDataFunc
to use for cell_layout
.
since: 2.4
Methods inherited from GtkScrollable (9)
gtk_scrollable_get_border
Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.
since: 3.16
gtk_scrollable_get_hadjustment
Retrieves the GtkAdjustment
used for horizontal scrolling.
since: 3.0
gtk_scrollable_get_hscroll_policy
Gets the horizontal GtkScrollablePolicy
.
since: 3.0
gtk_scrollable_get_vadjustment
Retrieves the GtkAdjustment
used for vertical scrolling.
since: 3.0
gtk_scrollable_get_vscroll_policy
Gets the vertical GtkScrollablePolicy
.
since: 3.0
gtk_scrollable_set_hadjustment
Sets the horizontal adjustment of the GtkScrollable
.
since: 3.0
gtk_scrollable_set_hscroll_policy
Sets the GtkScrollablePolicy
to determine whether
horizontal scrolling should start below the minimum width or
below the natural width.
since: 3.0
gtk_scrollable_set_vadjustment
Sets the vertical adjustment of the GtkScrollable
.
since: 3.0
gtk_scrollable_set_vscroll_policy
Sets the GtkScrollablePolicy
to determine whether
vertical scrolling should start below the minimum height or
below the natural height.
since: 3.0
Properties
Gtk.IconView:activate-on-single-click
The activate-on-single-click property specifies whether the “item-activated” signal will be emitted after a single click.
since: 3.8
Gtk.IconView:column-spacing
The column-spacing property specifies the space which is inserted between the columns of the icon view.
since: 2.6
Gtk.IconView:columns
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.
since: 2.6
Gtk.IconView:item-orientation
The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other.
since: 2.6
Gtk.IconView:item-padding
The item-padding property specifies the padding around each of the icon view’s item.
since: 2.18
Gtk.IconView:item-width
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.
since: 2.6
Gtk.IconView:margin
The margin property specifies the space which is inserted at the edges of the icon view.
since: 2.6
Gtk.IconView:markup-column
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.
since: 2.6
Gtk.IconView:pixbuf-column
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.
since: 2.6
Gtk.IconView:reorderable
The reorderable property specifies if the items can be reordered by DND.
since: 2.8
Gtk.IconView:row-spacing
The row-spacing property specifies the space which is inserted between the rows of the icon view.
since: 2.6
Gtk.IconView:selection-mode
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.
since: 2.6
Gtk.IconView:spacing
The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.
since: 2.6
Gtk.IconView:text-column
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.
since: 2.6
Properties inherited from GtkContainer (3)
Gtk.Container:border-width
Gtk.Container:child
Gtk.Container:resize-mode
Properties inherited from GtkWidget (39)
Gtk.Widget:app-paintable
Gtk.Widget:can-default
Gtk.Widget:can-focus
Gtk.Widget:composite-child
Gtk.Widget:double-buffered
Whether the widget is double buffered.
deprecated: 3.14 since: 2.18
Gtk.Widget:events
Gtk.Widget:expand
Whether to expand in both directions. Setting this sets both GtkWidget:hexpand
and GtkWidget:vexpand
.
since: 3.0
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
since: 3.20
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space, see GtkAlign
.
since: 3.0
Gtk.Widget:has-default
Gtk.Widget:has-focus
Gtk.Widget:has-tooltip
Enables or disables the emission of GtkWidget::query-tooltip
on widget
.
A value of TRUE
indicates that widget
can have a tooltip, in this case
the widget will be queried using GtkWidget::query-tooltip
to determine
whether it will provide a tooltip or not.
since: 2.12
Gtk.Widget:height-request
Gtk.Widget:hexpand
Whether to expand horizontally. See gtk_widget_set_hexpand().
since: 3.0
Gtk.Widget:hexpand-set
Whether to use the GtkWidget:hexpand
property. See gtk_widget_get_hexpand_set().
since: 3.0
Gtk.Widget:is-focus
Gtk.Widget:margin
Sets all four sides’ margin at once. If read, returns max margin on any side.
since: 3.0
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
since: 3.0
Gtk.Widget:margin-end
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
since: 3.12
Gtk.Widget:margin-left
Margin on left side of widget.
deprecated: 3.12 since: 3.0
Gtk.Widget:margin-right
Margin on right side of widget.
deprecated: 3.12 since: 3.0
Gtk.Widget:margin-start
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
since: 3.12
Gtk.Widget:margin-top
Margin on top side of widget.
since: 3.0
Gtk.Widget:name
Gtk.Widget:no-show-all
Gtk.Widget:opacity
The requested opacity of the widget. See gtk_widget_set_opacity()
for
more details about window opacity.
since: 3.8
Gtk.Widget:parent
Gtk.Widget:receives-default
Gtk.Widget:scale-factor
The scale factor of the widget. See gtk_widget_get_scale_factor()
for
more details about widget scaling.
since: 3.10
Gtk.Widget:sensitive
Gtk.Widget:style
The style of the widget, which contains information about how it will look (colors, etc).
deprecated: Unknown
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().
since: 2.12
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
since: 2.12
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space, see GtkAlign
.
since: 3.0
Gtk.Widget:vexpand
Whether to expand vertically. See gtk_widget_set_vexpand().
since: 3.0
Gtk.Widget:vexpand-set
Whether to use the GtkWidget:vexpand
property. See gtk_widget_get_vexpand_set().
since: 3.0
Gtk.Widget:visible
Gtk.Widget:width-request
Gtk.Widget:window
The widget’s window if it is realized, NULL
otherwise.
since: 2.14
Properties inherited from GtkScrollable (4)
GtkScrollable:hadjustment
Horizontal GtkAdjustment
of the scrollable widget. This adjustment is
shared between the scrollable widget and its parent.
since: 3.0
GtkScrollable:hscroll-policy
Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width.
since: 3.0
GtkScrollable:vadjustment
Verical GtkAdjustment
of the scrollable widget. This adjustment is shared
between the scrollable widget and its parent.
since: 3.0
GtkScrollable:vscroll-policy
Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height.
since: 3.0
Signals
Gtk.IconView::activate-cursor-item
A [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the currently focused item.
Gtk.IconView::item-activated
The ::item-activated signal is emitted when the method
gtk_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.
Gtk.IconView::move-cursor
The ::move-cursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement.
Gtk.IconView::select-all
A [keybinding signal][GtkBindingSignal] which gets emitted when the user selects all items.
Gtk.IconView::select-cursor-item
A [keybinding signal][GtkBindingSignal] which gets emitted when the user selects the item that is currently focused.
Gtk.IconView::selection-changed
The ::selection-changed signal is emitted when the selection (i.e. the set of selected items) changes.
Gtk.IconView::toggle-cursor-item
A [keybinding signal][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.
Gtk.IconView::unselect-all
A [keybinding signal][GtkBindingSignal] which gets emitted when the user unselects all items.
Signals inherited from GtkContainer (4)
GtkContainer::add
GtkContainer::check-resize
GtkContainer::remove
GtkContainer::set-focus-child
Signals inherited from GtkWidget (69)
GtkWidget::accel-closures-changed
GtkWidget::button-press-event
The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.
GtkWidget::button-release-event
The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.
GtkWidget::can-activate-accel
Determines whether an accelerator that activates the signal
identified by signal_id
can currently be activated.
This signal is present to allow applications and derived
widgets to override the default GtkWidget
handling
for determining whether an accelerator can be activated.
GtkWidget::child-notify
The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.
GtkWidget::composited-changed
The ::composited-changed signal is emitted when the composited
status of widgets
screen changes.
See gdk_screen_is_composited().
deprecated: 3.22
GtkWidget::configure-event
The ::configure-event signal will be emitted when the size, position or
stacking of the widget
‘s window has changed.
GtkWidget::damage-event
Emitted when a redirected window belonging to widget
gets drawn into.
The region/area members of the event shows what area of the redirected
drawable was drawn into.
since: 2.14
GtkWidget::delete-event
The ::delete-event signal is emitted if a user requests that
a toplevel window is closed. The default handler for this signal
destroys the window. Connecting gtk_widget_hide_on_delete()
to
this signal will cause the window to be hidden instead, so that
it can later be shown again without reconstructing it.
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.
GtkWidget::destroy-event
The ::destroy-event signal is emitted when a GdkWindow
is destroyed.
You rarely get this signal, because most widgets disconnect themselves
from their window before they destroy it, so no widget owns the
window at destroy time.
GtkWidget::direction-changed
The ::direction-changed signal is emitted when the text direction of a widget changes.
GtkWidget::drag-begin
The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
GtkWidget::drag-data-delete
The ::drag-data-delete signal is emitted on the drag source when a drag
with the action GDK_ACTION_MOVE
is successfully completed. The signal
handler is responsible for deleting the data that has been dropped. What
“delete” means depends on the context of the drag operation.
GtkWidget::drag-data-get
The ::drag-data-get signal is emitted on the drag source when the drop
site requests the data which is dragged. It is the responsibility of
the signal handler to fill data
with the data in the format which
is indicated by info
. See gtk_selection_data_set()
and gtk_selection_data_set_text().
GtkWidget::drag-data-received
The ::drag-data-received signal is emitted on the drop site when the
dragged data has been received. If the data was received in order to
determine whether the drop will be accepted, the handler is expected
to call gdk_drag_status()
and not finish the drag.
If the data was received in response to a GtkWidget::drag-drop
signal
(and this is the last target to be received), the handler for this
signal is expected to process the received data and then call
gtk_drag_finish(), setting the success
parameter depending on
whether the data was processed successfully.
GtkWidget::drag-drop
The ::drag-drop signal is emitted on the drop site when the user drops
the data onto the widget. The signal handler must determine whether
the cursor position is in a drop zone or not. If it is not in a drop
zone, it returns FALSE
and no further processing is necessary.
Otherwise, the handler returns TRUE
. In this case, the handler must
ensure that gtk_drag_finish()
is called to let the source know that
the drop is done. The call to gtk_drag_finish()
can be done either
directly or in a GtkWidget::drag-data-received
handler which gets
triggered by calling gtk_drag_get_data()
to receive the data for one
or more of the supported targets.
GtkWidget::drag-end
The ::drag-end signal is emitted on the drag source when a drag is
finished. A typical reason to connect to this signal is to undo
things done in GtkWidget::drag-begin
.
GtkWidget::drag-failed
The ::drag-failed signal is emitted on the drag source when a drag has
failed. The signal handler may hook custom code to handle a failed DnD
operation based on the type of error, it returns TRUE
is the failure has
been already handled (not showing the default “drag operation failed”
animation), otherwise it returns FALSE
.
since: 2.12
GtkWidget::drag-leave
The ::drag-leave signal is emitted on the drop site when the cursor
leaves the widget. A typical reason to connect to this signal is to
undo things done in GtkWidget::drag-motion
, e.g. undo highlighting
with gtk_drag_unhighlight().
GtkWidget::drag-motion
The ::drag-motion signal is emitted on the drop site when the user
moves the cursor over the widget during a drag. The signal handler
must determine whether the cursor position is in a drop zone or not.
If it is not in a drop zone, it returns FALSE
and no further processing
is necessary. Otherwise, the handler returns TRUE
. In this case, the
handler is responsible for providing the necessary information for
displaying feedback to the user, by calling gdk_drag_status().
GtkWidget::draw
This signal is emitted when a widget is supposed to render itself.
The widget
‘s top left corner must be painted at the origin of
the passed in context and be sized to the values returned by
gtk_widget_get_allocated_width()
and gtk_widget_get_allocated_height().
since: 3.0
GtkWidget::enter-notify-event
The ::enter-notify-event will be emitted when the pointer enters
the widget
‘s window.
GtkWidget::event
The GTK+ main loop will emit three signals for each GDK event delivered
to a widget: one generic ::event signal, another, more specific,
signal that matches the type of event delivered (e.g.
GtkWidget::key-press-event
) and finally a generic
GtkWidget::event-after
signal.
GtkWidget::event-after
After the emission of the GtkWidget::event
signal and (optionally)
the second more specific signal, ::event-after will be emitted
regardless of the previous two signals handlers return values.
GtkWidget::focus
GtkWidget::focus-in-event
The ::focus-in-event signal will be emitted when the keyboard focus
enters the widget
‘s window.
GtkWidget::focus-out-event
The ::focus-out-event signal will be emitted when the keyboard focus
leaves the widget
‘s window.
GtkWidget::grab-broken-event
Emitted when a pointer or keyboard grab on a window belonging
to widget
gets broken.
since: 2.8
GtkWidget::grab-focus
GtkWidget::grab-notify
The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.
GtkWidget::hide
The ::hide signal is emitted when widget
is hidden, for example with gtk_widget_hide().
GtkWidget::hierarchy-changed
The ::hierarchy-changed signal is emitted when the
anchored state of a widget changes. A widget is
“anchored” when its toplevel
ancestor is a GtkWindow
. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
GtkWidget::key-press-event
The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.
GtkWidget::key-release-event
The ::key-release-event signal is emitted when a key is released.
GtkWidget::keynav-failed
Gets emitted if keyboard navigation fails.
See gtk_widget_keynav_failed()
for details.
since: 2.12
GtkWidget::leave-notify-event
The ::leave-notify-event will be emitted when the pointer leaves
the widget
‘s window.
GtkWidget::map
The ::map signal is emitted when widget
is going to be mapped, that is
when the widget is visible (which is controlled with
gtk_widget_set_visible()) and all its parents up to the toplevel widget
are also visible. Once the map has occurred, GtkWidget::map-event
will
be emitted.
GtkWidget::map-event
The ::map-event signal will be emitted when the widget
‘s window is
mapped. A window is mapped when it becomes visible on the screen.
GtkWidget::mnemonic-activate
The default handler for this signal activates widget
if group_cycling
is FALSE
, or just makes widget
grab focus if group_cycling
is TRUE
.
GtkWidget::motion-notify-event
The ::motion-notify-event signal is emitted when the pointer moves
over the widget’s GdkWindow
.
GtkWidget::move-focus
GtkWidget::parent-set
The ::parent-set signal is emitted when a new parent has been set on a widget.
GtkWidget::popup-menu
This signal gets emitted whenever a widget should pop up a context
menu. This usually happens through the standard key binding mechanism;
by pressing a certain key while a widget is focused, the user can cause
the widget to pop up a menu. For example, the GtkEntry
widget creates
a menu with clipboard commands. See the
[Popup Menu Migration Checklist][checklist-popup-menu]
for an example of how to use this signal.
GtkWidget::property-notify-event
The ::property-notify-event signal will be emitted when a property on
the widget
‘s window has been changed or deleted.
GtkWidget::proximity-in-event
To receive this signal the GdkWindow
associated to the widget needs
to enable the #GDK_PROXIMITY_IN_MASK mask.
GtkWidget::proximity-out-event
To receive this signal the GdkWindow
associated to the widget needs
to enable the #GDK_PROXIMITY_OUT_MASK mask.
GtkWidget::query-tooltip
Emitted when GtkWidget:has-tooltip
is TRUE
and the hover timeout
has expired with the cursor hovering “above” widget
; or emitted when widget
got
focus in keyboard mode.
since: 2.12
GtkWidget::realize
The ::realize signal is emitted when widget
is associated with a
GdkWindow
, which means that gtk_widget_realize()
has been called or the
widget has been mapped (that is, it is going to be drawn).
GtkWidget::screen-changed
The ::screen-changed signal gets emitted when the screen of a widget has changed.
GtkWidget::scroll-event
The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
GtkWidget::selection-clear-event
The ::selection-clear-event signal will be emitted when the
the widget
‘s window has lost ownership of a selection.
GtkWidget::selection-get
GtkWidget::selection-notify-event
GtkWidget::selection-received
GtkWidget::selection-request-event
The ::selection-request-event signal will be emitted when
another client requests ownership of the selection owned by
the widget
‘s window.
GtkWidget::show
The ::show signal is emitted when widget
is shown, for example with gtk_widget_show().
GtkWidget::show-help
GtkWidget::size-allocate
GtkWidget::state-changed
The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().
deprecated: 3.0
GtkWidget::state-flags-changed
The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().
since: 3.0
GtkWidget::style-set
The ::style-set signal is emitted when a new style has been set
on a widget. Note that style-modifying functions like
gtk_widget_modify_base()
also cause this signal to be emitted.
deprecated: 3.0
GtkWidget::style-updated
The ::style-updated signal is a convenience signal that is emitted when the
GtkStyleContext::changed
signal is emitted on the widget
‘s associated
GtkStyleContext
as returned by gtk_widget_get_style_context().
since: 3.0
GtkWidget::touch-event
GtkWidget::unmap
The ::unmap signal is emitted when widget
is going to be unmapped, which
means that either it or any of its parents up to the toplevel widget have
been set as hidden.
GtkWidget::unmap-event
The ::unmap-event signal will be emitted when the widget
‘s window is
unmapped. A window is unmapped when it becomes invisible on the screen.
GtkWidget::unrealize
The ::unrealize signal is emitted when the GdkWindow
associated with
widget
is destroyed, which means that gtk_widget_unrealize()
has been
called or the widget has been unmapped (that is, it is going to be hidden).
GtkWidget::visibility-notify-event
The ::visibility-notify-event will be emitted when the widget
‘s
window is obscured or unobscured.
deprecated: 3.12
GtkWidget::window-state-event
The ::window-state-event will be emitted when the state of the
toplevel window associated to the widget
changes.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct GtkIconViewClass {
GtkContainerClass parent_class;
void (* item_activated) (
GtkIconView* icon_view,
GtkTreePath* path
);
void (* selection_changed) (
GtkIconView* icon_view
);
void (* select_all) (
GtkIconView* icon_view
);
void (* unselect_all) (
GtkIconView* icon_view
);
void (* select_cursor_item) (
GtkIconView* icon_view
);
void (* toggle_cursor_item) (
GtkIconView* icon_view
);
gboolean (* move_cursor) (
GtkIconView* icon_view,
GtkMovementStep step,
gint count
);
gboolean (* activate_cursor_item) (
GtkIconView* icon_view
);
void (* _gtk_reserved1) (
void
);
void (* _gtk_reserved2) (
void
);
void (* _gtk_reserved3) (
void
);
void (* _gtk_reserved4) (
void
);
}
No description available.
Class members
parent_class: GtkContainerClass
No description available.
item_activated: void (* item_activated) ( GtkIconView* icon_view, GtkTreePath* path )
No description available.
selection_changed: void (* selection_changed) ( GtkIconView* icon_view )
No description available.
select_all: void (* select_all) ( GtkIconView* icon_view )
No description available.
unselect_all: void (* unselect_all) ( GtkIconView* icon_view )
No description available.
select_cursor_item: void (* select_cursor_item) ( GtkIconView* icon_view )
No description available.
toggle_cursor_item: void (* toggle_cursor_item) ( GtkIconView* icon_view )
No description available.
move_cursor: gboolean (* move_cursor) ( GtkIconView* icon_view, GtkMovementStep step, gint count )
No description available.
activate_cursor_item: gboolean (* activate_cursor_item) ( GtkIconView* icon_view )
No description available.
_gtk_reserved1: void (* _gtk_reserved1) ( void )
No description available.
_gtk_reserved2: void (* _gtk_reserved2) ( void )
No description available.
_gtk_reserved3: void (* _gtk_reserved3) ( void )
No description available.
_gtk_reserved4: void (* _gtk_reserved4) ( void )
No description available.
Virtual methods
Gtk.IconViewClass.select_all
Selects all the icons. icon_view
must has its selection mode set
to #GTK_SELECTION_MULTIPLE.
since: 2.6