gtkmm: Gtk::IconView Class Reference

The IconView provides an alternative view of a list model. More...

#include <gtkmm/iconview.h>

Inheritance diagram for Gtk::IconView:

Public Types

typedef sigc::slot< void, const TreeModel::Path& > SlotForeach
 For instance, void on_foreach(const Gtk::TreeModel::Path& path);. More...

 
- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget& > ForeachSlot
 A slot to invoke with each child iterated over by foreach() or forall(). More...

 
- Public Types inherited from Gtk::Widget
using SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)>
 Callback type for adding a function to update animations. More...

 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from Gtk::CellLayout
typedef sigc::slot< void, const TreeModel::const_iterator& > SlotCellData
 

Public Member Functions

 IconView (IconView&& src) noexcept
 
IconViewoperator= (IconView&& src) noexcept
 
 IconView (const IconView&)=delete
 
IconViewoperator= (const IconView&)=delete
 
 ~IconView () noexcept override
 
GtkIconView* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkIconView* gobj () const
 Provides access to the underlying C GObject. More...

 
 IconView ()
 
 IconView (const Glib::RefPtr< TreeModel >& model)
 
 IconView (const Glib::RefPtr< CellArea >& cell_area)
 
void set_model (const Glib::RefPtr< TreeModel >& model)
 Sets the model for a Gtk::IconView. More...

 
Glib::RefPtr< TreeModelget_model ()
 Returns the model the Gtk::IconView is based on. More...

 
Glib::RefPtr< const TreeModelget_model () const
 Returns the model the Gtk::IconView is based on. More...

 
void unset_model ()
 Remove the model from the IconView. More...

 
void set_text_column (int column)
 Sets the column with text for icon_view to be column. More...

 
void set_text_column (const TreeModelColumnBase& model_column)
 Sets the column with text for icon_view to be model_column. More...

 
int get_text_column () const
 Returns the column with text for icon_view. More...

 
void set_markup_column (int column)
 Sets the column with markup information for icon_view to be column. More...

 
void set_markup_column (const TreeModelColumnBase& column)
 Sets the column with markup information for icon_view to be column. More...

 
int get_markup_column () const
 Returns the column with markup text for icon_view. More...

 
void set_pixbuf_column (int column)
 Sets the column with pixbufs for icon_view to be column. More...

 
void set_pixbuf_column (const TreeModelColumnBase& column)
 Sets the column with pixbufs for icon_view to be column. More...

 
int get_pixbuf_column () const
 Returns the column with pixbufs for icon_view. More...

 
void set_item_orientation (Orientation orientation)
 Sets the property_item_orientation() property which determines whether the labels are drawn beside the icons instead of below. More...

 
Orientation get_item_orientation () const
 Returns the value of the property_item_orientation() property which determines whether the labels are drawn beside the icons instead of below. More...

 
void set_columns (int columns)
 Sets the property_columns() property which determines in how many columns the icons are arranged. More...

 
int get_columns () const
 Returns the value of the property_columns() property. More...

 
void set_item_width (int item_width)
 Sets the property_item_width() property which specifies the width to use for each item. More...

 
int get_icon_width () const
 Returns the value of the property_item_width() property. More...

 
void set_spacing (int spacing)
 Sets the property_spacing() property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. More...

 
int get_spacing () const
 Returns the value of the property_spacing() property. More...

 
void set_row_spacing (int row_spacing)
 Sets the property_row_spacing() property which specifies the space which is inserted between the rows of the icon view. More...

 
gint get_row_spacing () const
 Returns the value of the property_row_spacing() property. More...

 
void set_column_spacing (int column_spacing)
 Sets the property_column_spacing() property which specifies the space which is inserted between the columns of the icon view. More...

 
int get_column_spacing () const
 Returns the value of the property_column_spacing() property. More...

 
void set_margin (int margin)
 Sets the property_margin() property which specifies the space which is inserted at the top, bottom, left and right of the icon view. More...

 
int get_margin () const
 Returns the value of the property_margin() property. More...

 
void set_item_padding (int item_padding)
 Sets the Gtk::IconView::property_item_padding() property which specifies the padding around each of the icon view’s items. More...

 
int get_item_padding () const
 Returns the value of the property_item_padding() property. More...

 
TreeModel::Path get_path_at_pos (int x, int y) const
 Finds the path at the point ( x, y), relative to bin_window coordinates. More...

 
bool get_item_at_pos (int x, int y, TreeModel::Path& path, CellRenderer*& cell) const
 Finds the path at the point (x, y), relative to widget coordinates. More...

 
bool get_item_at_pos (int x, int y, TreeModel::Path& path) const
 Finds the path at the point (x, y), relative to widget coordinates. More...

 
bool get_item_at_pos (int x, int y, CellRenderer*& cell) const
 Finds the path at the point (x, y), relative to widget coordinates. More...

 
bool get_visible_range (TreeModel::Path& start_path, TreeModel::Path& end_path) const
 
void set_activate_on_single_click (bool single=true)
 Causes the Gtk::IconView::signal_item_activated() signal to be emitted on a single click instead of a double click. More...

 
bool get_activate_on_single_click () const
 Gets the setting set by set_activate_on_single_click(). More...

 
void selected_foreach (const SlotForeach& slot)
 Calls a function for each selected icon. More...

 
void set_selection_mode (SelectionMode mode)
 Sets the selection mode of the icon_view. More...

 
SelectionMode get_selection_mode () const
 Gets the selection mode of the icon_view. More...

 
void select_path (const TreeModel::Path& path)
 Selects the row at path. More...

 
void unselect_path (const TreeModel::Path& path)
 Unselects the row at path. More...

 
bool path_is_selected (const TreeModel::Path& path) const
 Returns true if the icon pointed to by path is currently selected. More...

 
int get_item_row (const TreeModel::Path& path) const
 Gets the row in which the item path is currently displayed. More...

 
int get_item_column (const TreeModel::Path& path) const
 Gets the column in which the item path is currently displayed. More...

 
std::vector< TreePathget_selected_items () const
 Creates a list of paths of all selected items. More...

 
void select_all ()
 Selects all the icons. More...

 
void unselect_all ()
 Unselects all the icons. More...

 
void item_activated (const TreeModel::Path& path)
 Activates the item determined by path. More...

 
void set_cursor (const TreeModel::Path& path, CellRenderer& cell, bool start_editing)
 Sets the current keyboard focus to be at path, and selects it. More...

 
void set_cursor (const TreeModel::Path& path, bool start_editing)
 A set_cursor() convenience overload. More...

 
bool get_cursor (TreeModel::Path& path, CellRenderer*& cell) const
 Fills in path and cell with the current cursor path and cell. More...

 
bool get_cursor (TreeModel::Path& path) const
 Fills in path and cell with the current cursor path and cell. More...

 
bool get_cursor (CellRenderer*& cell) const
 Fills in path and cell with the current cursor path and cell. More...

 
void scroll_to_path (const TreeModel::Path& path, bool use_align, gfloat row_align, gfloat col_align)
 Moves the alignments of icon_view to the position specified by path. More...

 
void enable_model_drag_source (const std::vector< TargetEntry >& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
 Turns the IconView into a drag source for automatic DND. More...

 
void enable_model_drag_dest (const std::vector< TargetEntry >& targets, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
 Turns the IconView into a drop destination for automatic DND. More...

 
void unset_model_drag_source ()
 Undoes the effect of enable_model_drag_source(). More...

 
void unset_model_drag_dest ()
 Undoes the effect of enable_model_drag_dest(). More...

 
void set_reorderable (bool reorderable=true)
 This function is a convenience function to allow you to reorder models that support the Gtk::TreeDragSourceIface and the Gtk::TreeDragDestIface. More...

 
bool get_reorderable () const
 Retrieves whether the user can reorder the list via drag-and-drop. More...

 
void set_drag_dest_item (const TreeModel::Path& path, IconViewDropPosition pos)
 Sets the item that is highlighted for feedback. More...

 
void get_drag_dest_item (TreeModel::Path& path, IconViewDropPosition& pos) const
 Gets information about the item that is highlighted for feedback. More...

 
void get_drag_dest_item (TreeModel::Path& path) const
 Gets information about the item that is highlighted for feedback. More...

 
void get_drag_dest_item (IconViewDropPosition& pos) const
 Gets information about the item that is highlighted for feedback. More...

 
bool get_dest_item_at_pos (int drag_x, int drag_y, TreeModel::Path& path, IconViewDropPosition& pos) const
 Determines the destination item for a given position. More...

 
bool get_dest_item_at_pos (int drag_x, int drag_y, TreeModel::Path& path) const
 Determines the destination item for a given position. More...

 
bool get_dest_item_at_pos (int drag_x, int drag_y, IconViewDropPosition& pos) const
 Determines the destination item for a given position. More...

 
Cairo::RefPtr< Cairo::Surfacecreate_drag_icon (const TreeModel::Path& path)
 Creates a #cairo_surface_t representation of the item at path. More...

 
void convert_widget_to_bin_window_coords (int wx, int wy, int& bx, int& by) const
 Converts widget coordinates to coordinates for the bin_window, as expected by e.g. get_path_at_pos(). More...

 
bool get_cell_rect (const TreeModel::Path& path, const CellRenderer& cell, Gdk::Rectangle& rect) const
 Fills the bounding rectangle in widget coordinates for the cell specified by path and cell. More...

 
bool get_cell_rect (const TreeModel::Path& path, Gdk::Rectangle& rect) const
 A get_cell_rect() convenience overload. More...

 
void set_tooltip_item (const Glib::RefPtr< Tooltip >& tooltip, const TreeModel::Path& path)
 Sets the tip area of tooltip to be the area covered by the item at path. More...

 
void set_tooltip_cell (const Glib::RefPtr< Tooltip >& tooltip, const TreeModel::Path& path, CellRenderer& cell)
 Sets the tip area of tooltip to the area which cell occupies in the item pointed to by path. More...

 
void set_tooltip_cell (const Glib::RefPtr< Tooltip >& tooltip, const TreeModel::Path& path)
 Sets the tip area of tooltip to the area occupied by the item pointed to by path. More...

 
bool get_tooltip_context_path (int& x, int& y, bool keyboard_tip, TreeModel::Path& path)
 
bool get_tooltip_context_iter (int& x, int& y, bool keyboard_tip, Gtk::TreeModel::iterator& iter)
 
void set_tooltip_column (int column)
 If you only plan to have simple (text-only) tooltips on full items, you can use this function to have Gtk::IconView handle these automatically for you. More...

 
int get_tooltip_column () const
 Returns the column of icon_view’s model which is being used for displaying tooltips on icon_view’s rows. More...

 
Glib::SignalProxy< void, const TreeModel::Path& > signal_item_activated ()
 
Glib::SignalProxy< void > signal_selection_changed ()
 
Glib::PropertyProxy< int > property_pixbuf_column ()
 The property_pixbuf_column() property contains the number of the model column containing the pixbufs which are displayed. More...

 
Glib::PropertyProxy_ReadOnly< int > property_pixbuf_column () const
 The property_pixbuf_column() property contains the number of the model column containing the pixbufs which are displayed. More...

 
Glib::PropertyProxy< int > property_text_column ()
 The property_text_column() property contains the number of the model column containing the texts which are displayed. More...

 
Glib::PropertyProxy_ReadOnly< int > property_text_column () const
 The property_text_column() property contains the number of the model column containing the texts which are displayed. More...

 
Glib::PropertyProxy< int > property_markup_column ()
 The property_markup_column() property contains the number of the model column containing markup information to be displayed. More...

 
Glib::PropertyProxy_ReadOnly< int > property_markup_column () const
 The property_markup_column() property contains the number of the model column containing markup information to be displayed. More...

 
Glib::PropertyProxy< SelectionModeproperty_selection_mode ()
 The property_selection_mode() property specifies the selection mode of icon view. More...

 
Glib::PropertyProxy_ReadOnly< SelectionModeproperty_selection_mode () const
 The property_selection_mode() property specifies the selection mode of icon view. More...

 
Glib::PropertyProxy< Orientationproperty_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. More...

 
Glib::PropertyProxy_ReadOnly< Orientationproperty_item_orientation () const
 The item-orientation property specifies how the cells (i.e. the icon and the text) of the item are positioned relative to each other. More...

 
Glib::PropertyProxy< Glib::RefPtr< TreeModel > > property_model ()
 The model for the icon view. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > > property_model () const
 The model for the icon view. More...

 
Glib::PropertyProxy< int > property_columns ()
 The columns property contains the number of the columns in which the items should be displayed. More...

 
Glib::PropertyProxy_ReadOnly< int > property_columns () const
 The columns property contains the number of the columns in which the items should be displayed. More...

 
Glib::PropertyProxy< int > property_item_width ()
 The item-width property specifies the width to use for each item. More...

 
Glib::PropertyProxy_ReadOnly< int > property_item_width () const
 The item-width property specifies the width to use for each item. More...

 
Glib::PropertyProxy< int > property_spacing ()
 The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. More...

 
Glib::PropertyProxy_ReadOnly< int > property_spacing () const
 The spacing property specifies the space which is inserted between the cells (i.e. the icon and the text) of an item. More...

 
Glib::PropertyProxy< int > property_row_spacing ()
 The row-spacing property specifies the space which is inserted between the rows of the icon view. More...

 
Glib::PropertyProxy_ReadOnly< int > property_row_spacing () const
 The row-spacing property specifies the space which is inserted between the rows of the icon view. More...

 
Glib::PropertyProxy< int > property_column_spacing ()
 The column-spacing property specifies the space which is inserted between the columns of the icon view. More...

 
Glib::PropertyProxy_ReadOnly< int > property_column_spacing () const
 The column-spacing property specifies the space which is inserted between the columns of the icon view. More...

 
Glib::PropertyProxy< int > property_margin ()
 The margin property specifies the space which is inserted at the edges of the icon view. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin () const
 The margin property specifies the space which is inserted at the edges of the icon view. More...

 
Glib::PropertyProxy< int > property_reorderable ()
 The reorderable property specifies if the items can be reordered by DND. More...

 
Glib::PropertyProxy_ReadOnly< int > property_reorderable () const
 The reorderable property specifies if the items can be reordered by DND. More...

 
Glib::PropertyProxy< int > property_tooltip_column ()
 The column in the model containing the tooltip texts for the items. More...

 
Glib::PropertyProxy_ReadOnly< int > property_tooltip_column () const
 The column in the model containing the tooltip texts for the items. More...

 
Glib::PropertyProxy< int > property_item_padding ()
 The item-padding property specifies the padding around each of the icon view's item. More...

 
Glib::PropertyProxy_ReadOnly< int > property_item_padding () const
 The item-padding property specifies the padding around each of the icon view's item. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< CellArea > > property_cell_area () const
 The Gtk::CellArea used to layout cell renderers for this view. More...

 
Glib::PropertyProxy< bool > property_activate_on_single_click ()
 The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_activate_on_single_click () const
 The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click. More...

 
- Public Member Functions inherited from Gtk::Container
 Container (Container&& src) noexcept
 
Containeroperator= (Container&& src) noexcept
 
 Container (const Container&)=delete
 
Containeroperator= (const Container&)=delete
 
 ~Container () noexcept override
 
GtkContainer* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkContainer* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_border_width (guint border_width)
 Sets the border width of the container. More...

 
guint get_border_width () const
 Retrieves the border width of the container. More...

 
virtual void add (Widget& widget)
 Adds widget to container. More...

 
void remove (Widget& widget)
 Removes widget from the container. More...

 
void set_resize_mode (ResizeMode resize_mode)
 Sets the resize mode for the container. More...

 
ResizeMode get_resize_mode () const
 Returns the resize mode for the container. More...

 
void check_resize ()
 Request that contained widgets check their size. More...

 
void foreach (const ForeachSlot& slot)
 Operate on contained items. More...

 
void forall (const ForeachSlot& slot)
 Operate on contained items, including internal children. More...

 
std::vector< Widget* > get_children ()
 Returns the container’s non-internal children. More...

 
std::vector< const Widget* > get_children () const
 Returns the container’s non-internal children. More...

 
void propagate_draw (Widget& child, const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 When a container receives a call to the draw function, it must send synthetic Gtk::Widget::signal_draw() calls to all children that don’t have their own Gdk::Windows. More...

 
void set_focus_chain (const std::vector< Widget* >& focusable_widgets)
 Sets a focus chain, overriding the one computed automatically by GTK+. More...

 
bool has_focus_chain () const
 
std::vector< Widget* > get_focus_chain ()
 
std::vector< const Widget* > get_focus_chain () const
 
void unset_focus_chain ()
 Removes a focus chain explicitly set with set_focus_chain(). More...

 
void set_reallocate_redraws (bool needs_redraws=true)
 Sets the reallocate_redraws flag of the container to the given value. More...

 
void set_focus_child (Widget& widget)
 Sets the focus on a child. More...

 
Widgetget_focus_child ()
 Returns the current focus child widget inside container. More...

 
const Widgetget_focus_child () const
 Returns the current focus child widget inside container. More...

 
void set_focus_vadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_vadjustment ()
 Retrieves the vertical focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_vadjustment () const
 Retrieves the vertical focus adjustment for the container. More...

 
void set_focus_hadjustment (const Glib::RefPtr< Adjustment >& adjustment)
 Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

 
Glib::RefPtr< Adjustmentget_focus_hadjustment ()
 Retrieves the horizontal focus adjustment for the container. More...

 
Glib::RefPtr< const Adjustmentget_focus_hadjustment () const
 Retrieves the horizontal focus adjustment for the container. More...

 
void resize_children ()
 
GType child_type () const
 Returns the type of the children supported by the container. More...

 
WidgetPath get_path_for_child (const Widget& child) const
 Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child. More...

 
Glib::SignalProxy< void, Widget* > signal_add ()
 
Glib::SignalProxy< void, Widget* > signal_remove ()
 
Glib::SignalProxy< void > signal_check_resize ()
 
Glib::SignalProxy< void, Widget* > signal_set_focus_child ()
 
void show_all_children (bool recursive=true)
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget&& src) noexcept
 
Widgetoperator= (Widget&& src) noexcept
 
 Widget (const Widget&)=delete
 
Widgetoperator= (const Widget&)=delete
 
 ~Widget () noexcept override
 Destroys the widget. More...

 
GtkWidget* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkWidget* gobj () const
 Provides access to the underlying C GObject. More...

 
void show ()
 Flags a widget to be displayed. More...

 
void show_now ()
 Shows a widget. More...

 
void hide ()
 Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More...

 
void show_all ()
 Recursively shows a widget, and any child widgets (if the widget is a container). More...

 
void queue_draw ()
 Equivalent to calling queue_draw_area() for the entire area of a widget. More...

 
void queue_draw_area (int x, int y, int width, int height)
 Convenience function that calls queue_draw_region() on the region created from the given coordinates. More...

 
void queue_draw_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Invalidates the area of widget defined by region by calling gdk_window_invalidate_region() on the widget’s window and all its child windows. More...

 
void queue_resize ()
 This function is only for use in widget implementations. More...

 
void queue_allocate ()
 This function is only for use in widget implementations. More...

 
void size_allocate (const Allocation& allocation)
 This function is only used by Gtk::Container subclasses, to assign a size and position to their child widgets. More...

 
void size_allocate (const Allocation& allocation, int baseline)
 This function is only used by Gtk::Container subclasses, to assign a size, position and (optionally) baseline to their child widgets. More...

 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...

 
void get_preferred_width (int& minimum_width, int& natural_width) const
 Retrieves a widget’s initial minimum and natural width. More...

 
void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height) const
 Retrieves a widget’s minimum and natural height if it would be given the specified width. More...

 
void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height, int& minimum_baseline, int& natural_baseline) const
 Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width, or the default height if width is -1. More...

 
void get_preferred_height (int& minimum_height, int& natural_height) const
 Retrieves a widget’s initial minimum and natural height. More...

 
void get_preferred_width_for_height (int height, int& minimum_width, int& natural_width) const
 Retrieves a widget’s minimum and natural width if it would be given the specified height. More...

 
void get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const
 Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...

 
void add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More...

 
bool remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 Removes an accelerator from widget, previously installed with add_accelerator(). More...

 
void set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group)
 Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More...

 
bool mnemonic_activate (bool group_cycling)
 Emits the Gtk::Widget::signal_mnemonic_activate() signal. More...

 
bool event (GdkEvent* gdk_event)
 Rarely-used function. More...

 
int send_expose (GdkEvent* gdk_event)
 Very rarely-used function. More...

 
bool send_focus_change (GdkEvent* gdk_event)
 Sends the focus change gdk_event to widget. More...

 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...

 
void reparent (Widget& new_parent)
 Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More...

 
bool intersect (const Gdk::Rectangle& area) const
 
bool intersect (const Gdk::Rectangle& area, Gdk::Rectangle& intersection) const
 Computes the intersection of a widget’s area and area, storing the intersection in intersection, and returns true if there was an intersection. More...

 
::Cairo::RefPtr< ::Cairo::Regionregion_intersect (const ::Cairo::RefPtr< ::Cairo::Region >& region) const
 Computes the intersection of a widget’s area and region, returning the intersection. More...

 
void freeze_child_notify ()
 Stops emission of Gtk::Widget::signal_child_notify() signals on widget. More...

 
void child_notify (const Glib::ustring& child_property)
 Emits a Gtk::Widget::signal_child_notify() signal for the [child property][child-properties] child_property on widget. More...

 
void thaw_child_notify ()
 Reverts the effect of a previous call to freeze_child_notify(). More...

 
void set_can_focus (bool can_focus=true)
 Specifies whether widget can own the input focus. More...

 
bool get_can_focus () const
 Determines whether widget can own the input focus. More...

 
bool has_focus () const
 Determines if the widget has the global input focus. More...

 
bool is_focus () const
 Determines if the widget is the focus widget within its toplevel. More...

 
bool has_visible_focus () const
 Determines if the widget should show a visible indication that it has the global input focus. More...

 
void grab_focus ()
 Causes widget to have the keyboard focus for the Gtk::Window it's inside. More...

 
void set_focus_on_click (bool focus_on_click=true)
 Sets whether the widget should grab focus when it is clicked with the mouse. More...

 
bool get_focus_on_click () const
 Returns whether the widget should grab focus when it is clicked with the mouse. More...

 
void set_can_default (bool can_default=true)
 Specifies whether widget can be a default widget. More...

 
bool get_can_default () const
 Determines whether widget can be a default widget. More...

 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. More...

 
void grab_default ()
 Causes widget to become the default widget. More...

 
void set_receives_default (bool receives_default=true)
 Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool get_receives_default () const
 Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

 
bool has_grab () const
 Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More...

 
bool device_is_shadowed (const Glib::RefPtr< const Gdk::Device >& device)
 Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More...

 
void add_modal_grab ()
 Block events to everything else than this widget and its children. More...

 
void remove_modal_grab ()
 Remove the modal grab of the widget in case it was previously grabbed. More...

 
void set_name (const Glib::ustring& name)
 Widgets can be named, which allows you to refer to them from a CSS file. More...

 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...

 
void set_state (StateType state)
 This function is for use in widget implementations. More...

 
StateType get_state () const
 Returns the widget’s state. More...

 
void set_state_flags (StateFlags flags, bool clear=true)
 This function is for use in widget implementations. More...

 
void unset_state_flags (StateFlags flags)
 This function is for use in widget implementations. More...

 
StateFlags get_state_flags () const
 Returns the widget state as a flag set. More...

 
void set_sensitive (bool sensitive=true)
 Sets the sensitivity of a widget. More...

 
bool get_sensitive () const
 Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More...

 
bool is_sensitive () const
 Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More...

 
void set_visible (bool visible=true)
 Sets the visibility state of widget. More...

 
bool get_visible () const
 Determines whether the widget is visible. More...

 
bool is_visible () const
 Determines whether the widget and all its parents are marked as visible. More...

 
bool get_has_window () const
 Determines whether widget has a Gdk::Window of its own. More...

 
bool get_is_toplevel () const
 Determines whether widget is a toplevel widget. More...

 
bool get_is_drawable () const
 Determines whether widget can be drawn to. More...

 
bool get_realized () const
 Determines whether widget is realized. More...

 
bool get_mapped () const
 Whether the widget is mapped. More...

 
void set_app_paintable (bool app_paintable=true)
 Sets whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

 
bool get_app_paintable () const
 Determines whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

 
void set_double_buffered (bool double_buffered=true)
 Widgets are double buffered by default; you can use this function to turn off the buffering. More...

 
bool get_double_buffered () const
 Determines whether the widget is double buffered. More...

 
void set_redraw_on_allocate (bool redraw_on_allocate=true)
 Sets whether the entire widget is queued for drawing when its size allocation changes. More...

 
void set_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More...

 
bool get_child_visible () const
 Gets the value set with set_child_visible(). More...

 
Glib::RefPtr< Gdk::Windowget_window ()
 Returns the widget’s window if it is realized, nullptr otherwise. More...

 
Glib::RefPtr< const Gdk::Windowget_window () const
 Returns the widget’s window if it is realized, nullptr otherwise. More...

 
void register_window (const Glib::RefPtr< Gdk::Window >& window)
 Registers a Gdk::Window with the widget and sets it up so that the widget receives events for it. More...

 
void unregister_window (const Glib::RefPtr< Gdk::Window >& window)
 Unregisters a Gdk::Window from the widget that was previously set up with register_window(). More...

 
int get_allocated_width () const
 Returns the width that has currently been allocated to widget. More...

 
int get_allocated_height () const
 Returns the height that has currently been allocated to widget. More...

 
int get_allocated_baseline () const
 Returns the baseline that has currently been allocated to widget. More...

 
void get_allocated_size (Allocation& allocation, int& baseline) const
 Retrieves the widget’s allocated size. More...

 
Allocation get_allocation () const
 Retrieves the widget's location. More...

 
void set_allocation (const Allocation& allocation)
 Sets the widget’s allocation. More...

 
void set_clip (const Allocation& clip)
 Sets the widget’s clip. More...

 
Allocation get_clip () const
 Retrieves the widget’s clip area. More...

 
Containerget_parent ()
 Returns the parent container of widget. More...

 
const Containerget_parent () const
 Returns the parent container of widget. More...

 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 Gets widget’s parent window, or nullptr if it does not have one. More...

 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 Gets widget’s parent window, or nullptr if it does not have one. More...

 
void set_parent_window (const Glib::RefPtr< const Gdk::Window >& parent_window)
 Sets a non default parent window for widget. More...

 
bool child_focus (DirectionType direction)
 This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order. More...

 
bool keynav_failed (DirectionType direction)
 This function should be called whenever keyboard navigation within a single widget hits a boundary. More...

 
void error_bell ()
 Notifies the user about an input-related error on this widget. More...

 
void set_size_request (int width=-1, int height=-1)
 Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More...

 
void get_size_request (int& width, int& height) const
 Gets the size request that was explicitly set for the widget using set_size_request(). More...

 
void set_events (Gdk::EventMask events)
 Sets the event mask (see Gdk::EventMask) for a widget. More...

 
void add_events (Gdk::EventMask events)
 Adds the events in the bitfield events to the event mask for widget. More...

 
void set_device_events (const Glib::RefPtr< const Gdk::Device >& device, Gdk::EventMask events)
 Sets the device event mask (see Gdk::EventMask) for a widget. More...

 
void add_device_events (const Glib::RefPtr< const Gdk::Device >& device, Gdk::EventMask events)
 Adds the device events in the bitfield events to the event mask for widget. More...

 
void set_opacity (double opacity)
 Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More...

 
double get_opacity () const
 Fetches the requested opacity for this widget. More...

 
void set_device_enabled (const Glib::RefPtr< Gdk::Device >& device, bool enabled=true)
 Enables or disables a Gdk::Device to interact with widget and all its children. More...

 
bool get_device_enabled (const Glib::RefPtr< const Gdk::Device >& device) const
 Returns whether device can interact with widget and its children. More...

 
Containerget_toplevel ()
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
const Containerget_toplevel () const
 This function returns the topmost widget in the container hierarchy widget is a part of. More...

 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...

 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. More...

 
Glib::RefPtr< Gdk::Visualget_visual ()
 Gets the visual that will be used to render widget. More...

 
Glib::RefPtr< Gdk::Screenget_screen ()
 Get the Gdk::Screen from the toplevel window associated with this widget. More...

 
Glib::RefPtr< const Gdk::Screenget_screen () const
 Get the Gdk::Screen from the toplevel window associated with this widget. More...

 
bool has_screen () const
 Checks whether there is a Gdk::Screen is associated with this widget. More...

 
int get_scale_factor () const
 Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...

 
Glib::RefPtr< Gdk::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...

 
Glib::RefPtr< Gdk::Windowget_root_window ()
 Get the root window where this widget is located. More...

 
Glib::RefPtr< const Gdk::Windowget_root_window () const
 Get the root window where this widget is located. More...

 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...

 
Glib::RefPtr< Clipboardget_clipboard (const Glib::ustring& selection)
 Returns the clipboard object for the given selection to be used with widget. More...

 
Glib::RefPtr< const Clipboardget_clipboard (const Glib::ustring& selection) const
 Returns the clipboard object for the given selection to be used with widget. More...

 
bool get_hexpand () const
 Gets whether the widget would like any available extra horizontal space. More...

 
void set_hexpand (bool expand=true)
 Sets whether the widget would like any available extra horizontal space. More...

 
bool get_hexpand_set () const
 Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_hexpand_set (bool set=true)
 Sets whether the hexpand flag (see get_hexpand()) will be used. More...

 
bool get_vexpand () const
 Gets whether the widget would like any available extra vertical space. More...

 
void set_vexpand (bool expand=true)
 Sets whether the widget would like any available extra vertical space. More...

 
bool get_vexpand_set () const
 Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...

 
void set_vexpand_set (bool set=true)
 Sets whether the vexpand flag (see get_vexpand()) will be used. More...

 
void queue_compute_expand ()
 Mark widget as needing to recompute its expand flags. More...

 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...

 
bool get_support_multidevice () const
 Returns true if widget is multiple pointer aware. More...

 
void set_support_multidevice (bool support_multidevice=true)
 Enables or disables multiple pointer awareness. More...

 
Glib::RefPtr< Atk::Objectget_accessible ()
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Glib::RefPtr< const Atk::Objectget_accessible () const
 Returns the accessible object that describes the widget to an assistive technology. More...

 
Align get_halign () const
 Gets the value of the Gtk::Widget::property_halign() property. More...

 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...

 
Align get_valign () const
 Gets the value of the Gtk::Widget::property_valign() property. More...

 
Align get_valign_with_baseline () const
 Gets the value of the Gtk::Widget::property_valign() property, including Gtk::ALIGN_BASELINE. More...

 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...

 
int get_margin_left () const
 Gets the value of the Gtk::Widget::property_margin_left() property. More...

 
void set_margin_left (int margin)
 Sets the left margin of widget. More...

 
int get_margin_right () const
 Gets the value of the Gtk::Widget::property_margin_right() property. More...

 
void set_margin_right (int margin)
 Sets the right margin of widget. More...

 
int get_margin_start () const
 Gets the value of the Gtk::Widget::property_margin_start() property. More...

 
void set_margin_start (int margin)
 Sets the start margin of widget. More...

 
int get_margin_end () const
 Gets the value of the Gtk::Widget::property_margin_end() property. More...

 
void set_margin_end (int margin)
 Sets the end margin of widget. More...

 
int get_margin_top () const
 Gets the value of the Gtk::Widget::property_margin_top() property. More...

 
void set_margin_top (int margin)
 Sets the top margin of widget. More...

 
int get_margin_bottom () const
 Gets the value of the Gtk::Widget::property_margin_bottom() property. More...

 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...

 
Gdk::EventMask get_events () const
 Returns the event mask (see Gdk::EventMask) for the widget. More...

 
Gdk::EventMask get_device_events (const Glib::RefPtr< const Gdk::Device >& device) const
 Returns the events mask for the widget corresponding to an specific device. More...

 
void get_pointer (int& x, int& y) const
 Obtains the location of the mouse pointer in widget coordinates. More...

 
bool is_ancestor (Widget& ancestor) const
 Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More...

 
bool translate_coordinates (Widget& dest_widget, int src_x, int src_y, int& dest_x, int& dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...

 
void override_color (const Gdk::RGBA& color, StateFlags state=STATE_FLAG_NORMAL)
 Sets the color to use for a widget. More...

 
void unset_color (StateFlags state=STATE_FLAG_NORMAL)
 Undoes the effect of previous calls to override_color(). More...

 
void override_background_color (const Gdk::RGBA& color, StateFlags state=STATE_FLAG_NORMAL)
 Sets the background color to use for a widget. More...

 
void unset_background_color (StateFlags state=STATE_FLAG_NORMAL)
 Undoes the effect of previous calls to override_background_color(). More...

 
void override_font (const Pango::FontDescription& font_desc)
 Sets the font to use for a widget. More...

 
void unset_font ()
 Undoes the effect of previous calls to override_font(). More...

 
void override_symbolic_color (const Glib::ustring& name, const Gdk::RGBA& color)
 Sets a symbolic color for a widget. More...

 
void unset_symbolic_color (const Glib::ustring& name)
 Undoes the effect of previous calls to override_symbolic_color(). More...

 
void override_cursor (const Gdk::RGBA& cursor, const Gdk::RGBA& secondary_cursor)
 Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. More...

 
void unset_cursor ()
 Undoes the effect of previous calls to override_cursor(). More...

 
void reset_style ()
 Updates the style context of widget and all descendants by updating its widget path. More...

 
template<class PropertyType >
void get_style_property (const Glib::ustring& the_property_name, PropertyType& value) const
 Gets the value of a style property of widget. More...

 
Glib::RefPtr< Pango::Contextcreate_pango_context ()
 Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...

 
Glib::RefPtr< Pango::Contextget_pango_context ()
 Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...

 
void set_font_options (const ::Cairo::FontOptions& options)
 Sets the #cairo_font_options_t used for Pango rendering in this widget. More...

 
void unset_font_options ()
 Undoes the effect of previous calls to set_font_options(). More...

 
::Cairo::FontOptions get_font_options () const
 Returns the #cairo_font_options_t used for Pango rendering. More...

 
Glib::RefPtr< Pango::Layoutcreate_pango_layout (const Glib::ustring& text)
 Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...

 
Glib::RefPtr< Gdk::Pixbufrender_icon_pixbuf (const StockID& stock_id, IconSize size)
 A convenience function that uses the theme engine and style settings for widget to look up stock_id and render it to a pixbuf. More...

 
void set_composite_name (const Glib::ustring& name)
 Sets a widgets composite name. More...

 
void unset_composite_name ()
 
Glib::ustring get_composite_name () const
 Obtains the composite name of a widget. More...

 
void set_direction (TextDirection dir)
 Sets the reading direction on a particular widget. More...

 
TextDirection get_direction () const
 Gets the reading direction for a particular widget. More...

 
void shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Sets a shape for this widget’s GDK window. More...

 
void input_shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region >& region)
 Sets an input shape for this widget’s GDK window. More...

 
WidgetPath get_path () const
 Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created. More...

 
std::vector< Widget* > list_mnemonic_labels ()
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
std::vector< const Widget* > list_mnemonic_labels () const
 Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More...

 
void add_mnemonic_label (Widget& label)
 Adds a widget to the list of mnemonic labels for this widget. More...

 
void remove_mnemonic_label (Widget& label)
 Removes a widget from the list of mnemonic labels for this widget. More...

 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::ustring& target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const std::vector< TargetEntry >& targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window >& proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 Sets this widget as a proxy for drops to another window. More...

 
void drag_dest_unset ()
 Clears information about a drop destination set with gtk_drag_dest_set(). More...

 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::RefPtr< TargetList >& target_list) const
 Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. More...

 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 Returns the list of targets this widget can accept from drag-and-drop. More...

 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 Returns the list of targets this widget can accept from drag-and-drop. More...

 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList >& target_list)
 Sets the target types that this widget can accept from drag-and-drop. More...

 
void drag_dest_add_text_targets ()
 Add the text targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_dest_add_image_targets ()
 Add the image targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_dest_add_uri_targets ()
 Add the URI targets supported by Gtk::SelectionData to the target list of the drag destination. More...

 
void drag_source_set (const std::vector< TargetEntry >& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 Undoes the effects of gtk_drag_source_set(). More...

 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf >& pixbuf)
 Sets the icon that will be used for drags from a particular widget from a Gdk::Pixbuf. More...

 
void drag_source_set_icon (const StockID& stock_id)
 Sets the icon that will be used for drags from a particular source to a stock icon. More...

 
void drag_source_set_icon (const Glib::ustring& icon_name)
 Sets the icon that will be used for drags from a particular source to a themed icon. More...

 
void drag_source_add_text_targets ()
 Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_uri_targets ()
 Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
void drag_source_add_image_targets ()
 Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More...

 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event)
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event, int x, int y)
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 
void drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext >& context, int hot_x, int hot_y)
 
void queue_resize_no_redraw ()
 This function works like queue_resize(), except that the widget is not invalidated. More...

 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...

 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...

 
bool get_no_show_all () const
 Returns the current value of the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

 
void set_no_show_all (bool no_show_all=true)
 Sets the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

 
void set_parent (Widget& parent)
 This function is useful only when implementing subclasses of Gtk::Container. More...

 
void unparent ()
 This function is only for use in widget implementations. More...

 
void map ()
 This function is only for use in widget implementations. More...

 
void unmap ()
 This function is only for use in widget implementations. More...

 
void draw_insertion_cursor (const ::Cairo::RefPtr< ::Cairo::Context >& cr, const Gdk::Rectangle& location, bool is_primary, TextDirection direction, bool draw_arrow=true)
 Draws a text caret on cr at location. More...

 
void set_tooltip_window (Window& custom_window)
 Replaces the default window used for displaying tooltips with custom_window. More...

 
Windowget_tooltip_window ()
 Returns the Gtk::Window of the current tooltip. More...

 
void trigger_tooltip_query ()
 Triggers a tooltip query on the display where the toplevel of widget is located. More...

 
void set_tooltip_text (const Glib::ustring& text)
 Sets text as the contents of the tooltip. More...

 
Glib::ustring get_tooltip_text () const
 Gets the contents of the tooltip for widget. More...

 
void set_tooltip_markup (const Glib::ustring& markup)
 Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...

 
Glib::ustring get_tooltip_markup () const
 Gets the contents of the tooltip for widget. More...

 
void set_has_tooltip (bool has_tooltip=TRUE)
 Sets the has-tooltip property on widget to has_tooltip. More...

 
bool get_has_tooltip () const
 Returns the current value of the has-tooltip property. More...

 
int get_width () const
 
int get_height () const
 
bool is_composited () const
 Whether widget can rely on having its alpha channel drawn correctly. More...

 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...

 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...

 
Glib::RefPtr< Gtk::StyleContextget_style_context () const
 Returns the style context associated to widget. More...

 
Gdk::ModifierType get_modifier_mask (Gdk::ModifierIntent intent)
 Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More...

 
guint add_tick_callback (const SlotTick& slot)
 Queues an animation frame update and adds a callback to be called before each frame. More...

 
void remove_tick_callback (guint id)
 Removes a tick callback previously registered with add_tick_callback(). More...

 
void insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group)
 Inserts group into widget. More...

 
void remove_action_group (const Glib::ustring& name)
 Removes a group from the widget. More...

 
Glib::RefPtr< Gio::ActionGroupget_action_group (const Glib::ustring& prefix)
 Retrieves the Gio::ActionGroup that was registered using prefix. More...

 
Glib::RefPtr< const Gio::ActionGroupget_action_group (const Glib::ustring& prefix) const
 Retrieves the Gio::ActionGroup that was registered using prefix. More...

 
std::vector< Glib::ustringlist_action_prefixes () const
 Retrieves a nullptr-terminated array of strings containing the prefixes of Gio::ActionGroup's available to widget. More...

 
void set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map)
 Sets the font map to use for Pango rendering. More...

 
Glib::RefPtr< Pango::FontMapget_font_map ()
 Gets the font map that has been set with set_font_map(). More...

 
Glib::RefPtr< const Pango::FontMapget_font_map () const
 Gets the font map that has been set with set_font_map(). More...

 
Glib::SignalProxy< void > signal_show ()
 
Glib::SignalProxy< void > signal_hide ()
 
Glib::SignalProxy< void > signal_map ()
 Emitted on mapping of a widget to the screen. More...

 
Glib::SignalProxy< void > signal_unmap ()
 
Glib::SignalProxy< void > signal_realize ()
 Emitted on realization of a widget. More...

 
Glib::SignalProxy< void > signal_unrealize ()
 
Glib::SignalProxy< void, Allocation& > signal_size_allocate ()
 
Glib::SignalProxy< void, Gtk::StateTypesignal_state_changed ()
 
Glib::SignalProxy< void, Gtk::StateFlagssignal_state_flags_changed ()
 
Glib::SignalProxy< void, Widget* > signal_parent_changed ()
 Informs objects that their parent changed. More...

 
Glib::SignalProxy< void, Widget* > signal_hierarchy_changed ()
 
Glib::SignalProxy< void > signal_style_updated ()
 
Glib::SignalProxy< void, TextDirectionsignal_direction_changed ()
 
Glib::SignalProxy< void, bool > signal_grab_notify ()
 
Glib::SignalProxy< void, GParamSpec* > signal_child_notify ()
 
Glib::SignalProxyDetailedAnyType< void, GParamSpec* > signal_child_notify (const Glib::ustring& child_property_name)
 
Glib::SignalProxy< bool, bool > signal_mnemonic_activate ()
 
Glib::SignalProxy< void > signal_grab_focus ()
 
Glib::SignalProxy< bool, DirectionTypesignal_focus ()
 
Glib::SignalProxy< bool, GdkEvent* > signal_event ()
 
Glib::SignalProxy< void, GdkEvent* > signal_event_after ()
 
Glib::SignalProxy< bool, GdkEventButton* > signal_button_press_event ()
 Event triggered by user pressing button. More...

 
Glib::SignalProxy< bool, GdkEventButton* > signal_button_release_event ()
 Event triggered by user releasing button. More...

 
Glib::SignalProxy< bool, GdkEventScroll* > signal_scroll_event ()
 
Glib::SignalProxy< bool, GdkEventMotion* > signal_motion_notify_event ()
 Event triggered by user moving pointer. More...

 
Glib::SignalProxy< bool, GdkEventAny* > signal_delete_event ()
 
Glib::SignalProxy< bool, const ::Cairo::RefPtr< ::Cairo::Context >& > signal_draw ()
 
Glib::SignalProxy< bool, GdkEventKey* > signal_key_press_event ()
 Event triggered by a key press will widget has focus. More...

 
Glib::SignalProxy< bool, GdkEventKey* > signal_key_release_event ()
 Event triggered by a key release will widget has focus. More...

 
Glib::SignalProxy< bool, GdkEventCrossing* > signal_enter_notify_event ()
 Event triggered by pointer entering widget area. More...

 
Glib::SignalProxy< bool, GdkEventCrossing* > signal_leave_notify_event ()
 Event triggered by pointer leaving widget area. More...

 
Glib::SignalProxy< bool, GdkEventConfigure* > signal_configure_event ()
 Event triggered by a window resizing. More...

 
Glib::SignalProxy< bool, GdkEventFocus* > signal_focus_in_event ()
 
Glib::SignalProxy< bool, GdkEventFocus* > signal_focus_out_event ()
 
Glib::SignalProxy< bool, GdkEventAny* > signal_map_event ()
 
Glib::SignalProxy< bool, GdkEventAny* > signal_unmap_event ()
 
Glib::SignalProxy< bool, GdkEventProperty* > signal_property_notify_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_clear_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_request_event ()
 
Glib::SignalProxy< bool, GdkEventSelection* > signal_selection_notify_event ()
 
Glib::SignalProxy< bool, GdkEventProximity* > signal_proximity_in_event ()
 
Glib::SignalProxy< bool, GdkEventProximity* > signal_proximity_out_event ()
 
Glib::SignalProxy< bool, GdkEventVisibility* > signal_visibility_notify_event ()
 
Glib::SignalProxy< bool, GdkEventWindowState* > signal_window_state_event ()
 
Glib::SignalProxy< void, SelectionData&, guint, guint > signal_selection_get ()
 
Glib::SignalProxy< void, const SelectionData&, guint > signal_selection_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_begin ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_end ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, SelectionData&, guint, guint > signal_drag_data_get ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >& > signal_drag_data_delete ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, DragResultsignal_drag_failed ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, guint > signal_drag_leave ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > signal_drag_motion ()
 
Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext >&, int, int, guint > signal_drag_drop ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext >&, int, int, const SelectionData&, guint, guint > signal_drag_data_received ()
 
Glib::SignalProxy< void, const Glib::RefPtr< Gdk::Screen >& > signal_screen_changed ()
 
Glib::SignalProxy< void > signal_composited_changed ()
 
Glib::SignalProxy< bool > signal_popup_menu ()
 
Glib::SignalProxy< bool, int, int, bool, const Glib::RefPtr< Tooltip >& > signal_query_tooltip ()
 
Glib::SignalProxy< bool, GdkEventGrabBroken* > signal_grab_broken_event ()
 
Glib::SignalProxy< bool, GdkEventExpose* > signal_damage_event ()
 
Glib::SignalProxy< bool, GdkEventTouch* > signal_touch_event ()
 
Glib::PropertyProxy< Glib::ustringproperty_name ()
 The name of the widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 The name of the widget. More...

 
Glib::PropertyProxy< Container* > property_parent ()
 The parent widget of this widget. More...

 
Glib::PropertyProxy_ReadOnly< Container* > property_parent () const
 The parent widget of this widget. More...

 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget, or -1 if natural request should be used. More...

 
Glib::PropertyProxy< bool > property_visible ()
 Whether the widget is visible. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the widget is visible. More...

 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the widget responds to input. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the widget responds to input. More...

 
Glib::PropertyProxy< bool > property_app_paintable ()
 Whether the application will paint directly on the widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_app_paintable () const
 Whether the application will paint directly on the widget. More...

 
Glib::PropertyProxy< bool > property_can_focus ()
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget can accept the input focus. More...

 
Glib::PropertyProxy< bool > property_has_focus ()
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...

 
Glib::PropertyProxy< bool > property_is_focus ()
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 Whether the widget is the focus widget within the toplevel. More...

 
Glib::PropertyProxy< bool > property_focus_on_click ()
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click () const
 Whether the widget should grab focus when it is clicked with the mouse. More...

 
Glib::PropertyProxy< bool > property_can_default ()
 Whether the widget can be the default widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_can_default () const
 Whether the widget can be the default widget. More...

 
Glib::PropertyProxy< bool > property_has_default ()
 Whether the widget is the default widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...

 
Glib::PropertyProxy< bool > property_receives_default ()
 If true, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 If true, the widget will receive the default action when it is focused. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_composite_child () const
 Whether the widget is part of a composite widget. More...

 
Glib::PropertyProxy< Glib::RefPtr< Style > > property_style ()
 The style of the widget, which contains information about how it will look (colors, etc). More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > property_style () const
 The style of the widget, which contains information about how it will look (colors, etc). More...

 
Glib::PropertyProxy< Gdk::EventMaskproperty_events ()
 The event mask that decides what kind of GdkEvents this widget gets. More...

 
Glib::PropertyProxy_ReadOnly< Gdk::EventMaskproperty_events () const
 The event mask that decides what kind of GdkEvents this widget gets. More...

 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_markup ()
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_markup () const
 Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More...

 
Glib::PropertyProxy< Glib::ustringproperty_tooltip_text ()
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip_text () const
 Sets the text of tooltip to be the given string. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > property_window () const
 The widget's window if it is realized, nullptr otherwise. More...

 
Glib::PropertyProxy< bool > property_no_show_all ()
 Whether Gtk::Widget::show_all() should not affect this widget. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_no_show_all () const
 Whether Gtk::Widget::show_all() should not affect this widget. More...

 
Glib::PropertyProxy< bool > property_double_buffered ()
 Whether the widget is double buffered. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_double_buffered () const
 Whether the widget is double buffered. More...

 
Glib::PropertyProxy< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space, see Gtk::Align. More...

 
Glib::PropertyProxy< int > property_margin_left ()
 Margin on left side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_left () const
 Margin on left side of widget. More...

 
Glib::PropertyProxy< int > property_margin_right ()
 Margin on right side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_right () const
 Margin on right side of widget. More...

 
Glib::PropertyProxy< int > property_margin_start ()
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_start () const
 Margin on start of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_end ()
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_end () const
 Margin on end of widget, horizontally. More...

 
Glib::PropertyProxy< int > property_margin_top ()
 Margin on top side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_top () const
 Margin on top side of widget. More...

 
Glib::PropertyProxy< int > property_margin_bottom ()
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin_bottom () const
 Margin on bottom side of widget. More...

 
Glib::PropertyProxy< int > property_margin ()
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy_ReadOnly< int > property_margin () const
 Sets all four sides' margin at once. More...

 
Glib::PropertyProxy< bool > property_hexpand ()
 Whether to expand horizontally. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand () const
 Whether to expand horizontally. More...

 
Glib::PropertyProxy< bool > property_hexpand_set ()
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the Gtk::Widget::property_hexpand() property. More...

 
Glib::PropertyProxy< bool > property_vexpand ()
 Whether to expand vertically. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand () const
 Whether to expand vertically. More...

 
Glib::PropertyProxy< bool > property_vexpand_set ()
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the Gtk::Widget::property_vexpand() property. More...

 
Glib::PropertyProxy< bool > property_expand ()
 Whether to expand in both directions. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_expand () const
 Whether to expand in both directions. More...

 
Glib::PropertyProxy< double > property_opacity ()
 The requested opacity of the widget. More...

 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 The requested opacity of the widget. More...

 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...

 
- Public Member Functions inherited from Gtk::Object
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
 ~Object () noexcept override
 
GObject* gobj ()
 Provides access to the underlying C GObject. More...

 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...

 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable&& src) noexcept
 
Buildableoperator= (Buildable&& src) noexcept
 
 ~Buildable () noexcept override
 
GtkBuildable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkBuildable* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_name (const Glib::ustring& name)
 Sets the name of the buildable object. More...

 
Glib::ustring get_name () const
 Gets the name of the buildable object. More...

 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Atk::Implementor
 Implementor (Implementor &&src) noexcept
 
Implementoroperator= (Implementor &&src) noexcept
 
 ~Implementor () noexcept override
 
AtkImplementor * gobj ()
 
const AtkImplementor * gobj () const
 
Glib::RefPtr< Atk::Implementorwrap (AtkImplementor *object, bool take_copy=false)
 
- Public Member Functions inherited from Gtk::CellLayout
 CellLayout (CellLayout&& src) noexcept
 
CellLayoutoperator= (CellLayout&& src) noexcept
 
 ~CellLayout () noexcept override
 
GtkCellLayout* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkCellLayout* gobj () const
 Provides access to the underlying C GObject. More...

 
template<class ColumnType >
void pack_start (const TreeModelColumn< ColumnType >& model_column, bool expand=true)
 
void pack_start (CellRenderer& cell, bool expand=true)
 Packs the cell into the beginning of cell_layout. More...

 
void pack_end (CellRenderer& cell, bool expand=true)
 Adds the cell to the end of cell_layout. More...

 
std::vector< CellRenderer* > get_cells ()
 Return value: a list of cell renderers. More...

 
std::vector< const CellRenderer* > get_cells () const
 Return value: a list of cell renderers. More...

 
CellRendererget_first_cell ()
 Gets the CellRenderer for the first column if any has been added, or nullptr otherwise. More...

 
const CellRendererget_first_cell () const
 Gets the CellRenderer for the first column if any has been added, or nullptr otherwise. More...

 
void clear ()
 Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout. More...

 
void add_attribute (CellRenderer& cell, const Glib::ustring& attribute, int column)
 Adds an attribute mapping to the list in cell_layout. More...

 
void add_attribute (const Glib::PropertyProxy_Base& property, const TreeModelColumnBase& column)
 
void add_attribute (CellRenderer& cell, const Glib::ustring& attribute, const TreeModelColumnBase& column)
 
void set_cell_data_func (CellRenderer& cell, const SlotCellData& slot)
 
void clear_attributes (CellRenderer& cell)
 Clears all existing attributes previously set with set_attributes(). More...

 
void reorder (CellRenderer& cell, int position)
 Re-inserts cell at position. More...

 
Glib::RefPtr< CellAreaget_area ()
 Returns the underlying Gtk::CellArea which might be cell_layout if called on a Gtk::CellArea or might be nullptr if no Gtk::CellArea is used by cell_layout. More...

 
Glib::RefPtr< const CellAreaget_area () const
 Returns the underlying Gtk::CellArea which might be cell_layout if called on a Gtk::CellArea or might be nullptr if no Gtk::CellArea is used by cell_layout. More...

 
template<class T_ModelColumnType >
void pack_start (const TreeModelColumn< T_ModelColumnType >& column, bool expand)
 
- Public Member Functions inherited from Gtk::Scrollable
 Scrollable (Scrollable&& src) noexcept
 
Scrollableoperator= (Scrollable&& src) noexcept
 
 ~Scrollable () noexcept override
 
GtkScrollable* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkScrollable* gobj () const
 Provides access to the underlying C GObject. More...

 
Glib::RefPtr< Adjustmentget_hadjustment ()
 Retrieves the Gtk::Adjustment used for horizontal scrolling. More...

 
Glib::RefPtr< const Adjustmentget_hadjustment () const
 Retrieves the Gtk::Adjustment used for horizontal scrolling. More...

 
void set_hadjustment (const Glib::RefPtr< Adjustment >& hadjustment)
 Sets the horizontal adjustment of the Gtk::Scrollable. More...

 
void unset_hadjustment ()
 This method removes the hadjustment. More...

 
Glib::RefPtr< Adjustmentget_vadjustment ()
 Retrieves the Gtk::Adjustment used for vertical scrolling. More...

 
Glib::RefPtr< const Adjustmentget_vadjustment () const
 Retrieves the Gtk::Adjustment used for vertical scrolling. More...

 
void set_vadjustment (const Glib::RefPtr< Adjustment >& vadjustment)
 Sets the vertical adjustment of the Gtk::Scrollable. More...

 
void unset_vadjustment ()
 This method removes the vadjustment. More...

 
ScrollablePolicy get_hscroll_policy () const
 Gets the horizontal Gtk::ScrollablePolicy. More...

 
void set_hscroll_policy (ScrollablePolicy policy)
 Sets the Gtk::ScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width. More...

 
ScrollablePolicy get_vscroll_policy () const
 Gets the vertical Gtk::ScrollablePolicy. More...

 
void set_vscroll_policy (ScrollablePolicy policy)
 Sets the Gtk::ScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height. More...

 
bool get_border (Border& border) const
 Returns the size of a non-scrolling border around the outside of the scrollable. More...

 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_hadjustment ()
 Horizontal Gtk::Adjustment of the scrollable widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_hadjustment () const
 Horizontal Gtk::Adjustment of the scrollable widget. More...

 
Glib::PropertyProxy< Glib::RefPtr< Adjustment > > property_vadjustment ()
 Verical Gtk::Adjustment of the scrollable widget. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > property_vadjustment () const
 Verical Gtk::Adjustment of the scrollable widget. More...

 
Glib::PropertyProxy< ScrollablePolicyproperty_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. More...

 
Glib::PropertyProxy_ReadOnly< ScrollablePolicyproperty_hscroll_policy () const
 Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. More...

 
Glib::PropertyProxy< ScrollablePolicyproperty_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. More...

 
Glib::PropertyProxy_ReadOnly< ScrollablePolicyproperty_vscroll_policy () const
 Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Container
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Widgetget_current_modal_grab ()
 Retrieve the widget which is currently grabbing all events. More...

 
static void push_composite_child ()
 Makes all newly-created widgets as composite children until the corresponding pop_composite_child() call. More...

 
static void pop_composite_child ()
 Cancels the effect of a previous call to push_composite_child(). More...

 
static void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More...

 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...

 
static Widgetdrag_get_source_widget (const Glib::RefPtr< Gdk::DragContext >& context)
 
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Atk::Implementor
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 
- Static Public Member Functions inherited from Gtk::CellLayout
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Gtk::Scrollable
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

virtual void on_item_activated (const TreeModel::Path& path)
 This is a default handler for the signal signal_item_activated(). More...

 
virtual void on_selection_changed ()
 This is a default handler for the signal signal_selection_changed(). More...

 
- Protected Member Functions inherited from Gtk::Container
virtual void on_add (Widget* widget)
 This is a default handler for the signal signal_add(). More...

 
virtual void on_remove (Widget* widget)
 This is a default handler for the signal signal_remove(). More...

 
virtual void on_check_resize ()
 This is a default handler for the signal signal_check_resize(). More...

 
virtual void on_set_focus_child (Widget* widget)
 This is a default handler for the signal signal_set_focus_child(). More...

 
 Container ()
 
virtual GType child_type_vfunc () const
 Implements child_type(). More...

 
virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
 Invokes a callback on all children of the container. More...

 
virtual char* composite_name_vfunc (GtkWidget* child)
 Returns the composite name of a child widget. More...

 
virtual void set_child_property_vfunc (GtkWidget* child, guint property_id, const GValue* value, GParamSpec* pspec)
 Sets a child property for this container and its child. More...

 
virtual void get_child_property_vfunc (GtkWidget* child, guint property_id, GValue* value, GParamSpec* pspec) const
 Returns a child property for this container and its child. More...

 
Glib::PropertyProxy< guint > property_border_width ()
 The width of the empty border outside the containers children. More...

 
Glib::PropertyProxy_ReadOnly< guint > property_border_width () const
 The width of the empty border outside the containers children. More...

 
Glib::PropertyProxy< ResizeModeproperty_resize_mode ()
 Specify how resize events are handled. More...

 
Glib::PropertyProxy_ReadOnly< ResizeModeproperty_resize_mode () const
 Specify how resize events are handled. More...

 
Glib::PropertyProxy_WriteOnly< Widget* > property_child ()
 Can be used to add a new child to the container. More...

 
- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...

 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...

 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...

 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...

 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...

 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...

 
virtual void on_size_allocate (Allocation& allocation)
 This is a default handler for the signal signal_size_allocate(). More...

 
virtual void on_state_changed (Gtk::StateType previous_state)
 This is a default handler for the signal signal_state_changed(). More...

 
virtual void on_parent_changed (Widget* previous_parent)
 This is a default handler for the signal signal_parent_changed(). More...

 
virtual void on_hierarchy_changed (Widget* previous_toplevel)
 This is a default handler for the signal signal_hierarchy_changed(). More...

 
virtual void on_style_updated ()
 This is a default handler for the signal signal_style_updated(). More...

 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...

 
virtual void on_grab_notify (bool was_grabbed)
 This is a default handler for the signal signal_grab_notify(). More...

 
virtual void on_child_notify (GParamSpec* pspec)
 This is a default handler for the signal signal_child_notify(). More...

 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...

 
virtual void on_grab_focus ()
 This is a default handler for the signal signal_grab_focus(). More...

 
virtual bool on_focus (DirectionType direction)
 This is a default handler for the signal signal_focus(). More...

 
virtual bool on_event (GdkEvent* gdk_event)
 This is a default handler for the signal signal_event(). More...

 
virtual bool on_button_press_event (GdkEventButton* button_event)
 This is a default handler for the signal signal_button_press_event(). More...

 
virtual bool on_button_release_event (GdkEventButton* release_event)
 This is a default handler for the signal signal_button_release_event(). More...

 
virtual bool on_scroll_event (GdkEventScroll* scroll_event)
 This is a default handler for the signal signal_scroll_event(). More...

 
virtual bool on_motion_notify_event (GdkEventMotion* motion_event)
 This is a default handler for the signal signal_motion_notify_event(). More...

 
virtual bool on_delete_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_delete_event(). More...

 
virtual bool on_draw (const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 This is a default handler for the signal signal_draw(). More...

 
virtual bool on_key_press_event (GdkEventKey* key_event)
 This is a default handler for the signal signal_key_press_event(). More...

 
virtual bool on_key_release_event (GdkEventKey* key_event)
 This is a default handler for the signal signal_key_release_event(). More...

 
virtual bool on_enter_notify_event (GdkEventCrossing* crossing_event)
 This is a default handler for the signal signal_enter_notify_event(). More...

 
virtual bool on_leave_notify_event (GdkEventCrossing* crossing_event)
 This is a default handler for the signal signal_leave_notify_event(). More...

 
virtual bool on_configure_event (GdkEventConfigure* configure_event)
 This is a default handler for the signal signal_configure_event(). More...

 
virtual bool on_focus_in_event (GdkEventFocus* focus_event)
 This is a default handler for the signal signal_focus_in_event(). More...

 
virtual bool on_focus_out_event (GdkEventFocus* gdk_event)
 This is a default handler for the signal signal_focus_out_event(). More...

 
virtual bool on_map_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_map_event(). More...

 
virtual bool on_unmap_event (GdkEventAny* any_event)
 This is a default handler for the signal signal_unmap_event(). More...

 
virtual bool on_property_notify_event (GdkEventProperty* property_event)
 This is a default handler for the signal signal_property_notify_event(). More...

 
virtual bool on_selection_clear_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_clear_event(). More...

 
virtual bool on_selection_request_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_request_event(). More...

 
virtual bool on_selection_notify_event (GdkEventSelection* selection_event)
 This is a default handler for the signal signal_selection_notify_event(). More...

 
virtual bool on_proximity_in_event (GdkEventProximity* proximity_event)
 This is a default handler for the signal signal_proximity_in_event(). More...

 
virtual bool on_proximity_out_event (GdkEventProximity* proximity_event)
 This is a default handler for the signal signal_proximity_out_event(). More...

 
virtual bool on_visibility_notify_event (GdkEventVisibility* visibility_event)
 This is a default handler for the signal signal_visibility_notify_event(). More...

 
virtual bool on_window_state_event (GdkEventWindowState* window_state_event)
 This is a default handler for the signal signal_window_state_event(). More...

 
virtual void on_selection_get (SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_selection_get(). More...

 
virtual void on_selection_received (const SelectionData& selection_data, guint time)
 This is a default handler for the signal signal_selection_received(). More...

 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_begin(). More...

 
virtual void on_drag_end (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_end(). More...

 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::DragContext >& context, SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_get(). More...

 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext >& context)
 This is a default handler for the signal signal_drag_data_delete(). More...

 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::DragContext >& context, guint time)
 This is a default handler for the signal signal_drag_leave(). More...

 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_motion(). More...

 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_drop(). More...

 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::DragContext >& context, int x, int y, const SelectionData& selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_received(). More...

 
virtual void on_screen_changed (const Glib::RefPtr< Gdk::Screen >& previous_screen)
 This is a default handler for the signal signal_screen_changed(). More...

 
virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec** p2)
 
virtual void show_all_vfunc ()
 
virtual Glib::RefPtr< Atk::Objectget_accessible_vfunc ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void get_preferred_width_vfunc (int& minimum_width, int& natural_width) const
 
virtual void get_preferred_height_for_width_vfunc (int width, int& minimum_height, int& natural_height) const
 
virtual void get_preferred_height_vfunc (int& minimum_height, int& natural_height) const
 
virtual void get_preferred_width_for_height_vfunc (int height, int& minimum_width, int& natural_width) const
 
 Widget ()
 
void realize ()
 Creates the GDK (windowing system) resources associated with a widget. More...

 
void unrealize ()
 This function is only useful in widget implementations. More...

 
void draw (const ::Cairo::RefPtr< ::Cairo::Context >& cr)
 Draws widget to cr. More...

 
void set_mapped (bool mapped=true)
 Marks the widget as being mapped. More...

 
void set_realized (bool realized=true)
 Marks the widget as being realized. More...

 
void set_has_window (bool has_window=true)
 Specifies whether widget has a Gdk::Window of its own. More...

 
void set_window (const Glib::RefPtr< Gdk::Window >& window)
 Sets a widget's window. More...

 
void transform_cairo_context_to_window (const ::Cairo::RefPtr< ::Cairo::Context >& cr, const Glib::RefPtr< const Gdk::Window >& window)
 Transforms the given cairo context cr from widget-relative coordinates to window-relative coordinates. More...

 
Requisition get_requisition () const
 Retrieves the widget's requisition. More...

 
void get_style_property_value (const Glib::ustring& the_property_name, Glib::ValueBase& value) const
 Gets the value of a style property of widget. More...

 
void realize_if_needed ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...

 
- Protected Member Functions inherited from Atk::Implementor
 Implementor ()
 
virtual Glib::RefPtr< Objectref_accessibile_vfunc ()
 
- Protected Member Functions inherited from Gtk::CellLayout
 CellLayout ()
 You should derive from this class to use it. More...

 
virtual void pack_start_vfunc (CellRenderer* cell, bool expand)
 
virtual void pack_end_vfunc (CellRenderer* cell, bool expand)
 
virtual void clear_vfunc ()
 
virtual void add_attribute_vfunc (CellRenderer* cell, const Glib::ustring& attribute, int column)
 
virtual void clear_attributes_vfunc (CellRenderer* cell)
 
virtual void reorder_vfunc (CellRenderer* cell, int position)
 
- Protected Member Functions inherited from Gtk::Scrollable
 Scrollable ()
 You should derive from this class to use it. More...

 

Related Functions

(Note that these are not member functions.)

Gtk::IconViewwrap (GtkIconView* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Static Protected Member Functions inherited from Gtk::Widget
static bool should_draw_window (const ::Cairo::RefPtr< const ::Cairo::Context >& cr, const Glib::RefPtr< const Gdk::Window >& window)
 This function is supposed to be called in Gtk::Widget::signal_draw() implementations for widgets that support multiple windows. More...

 

Detailed Description

The IconView provides an alternative view of a list model.

It displays the model as a grid of icons with labels. Like the TreeView, it allows the user to select one or multiple items (depending on the selection mode - see set_selection_mode()). In addition to selection with the arrow keys, the IconView supports rubberband selection, by dragging the pointer.

Member Typedef Documentation

For instance, void on_foreach(const Gtk::TreeModel::Path& path);.

Constructor & Destructor Documentation

Gtk::IconView::IconView ( IconView&&  src)
noexcept
Gtk::IconView::IconView ( const IconView )
delete
Gtk::IconView::~IconView ( )
overridenoexcept
Gtk::IconView::IconView ( )
Gtk::IconView::IconView ( const Glib::RefPtr< TreeModel >&  model)
explicit
Gtk::IconView::IconView ( const Glib::RefPtr< CellArea >&  cell_area)
explicit

Member Function Documentation

void Gtk::IconView::convert_widget_to_bin_window_coords ( int  wx,
int  wy,
int &  bx,
int &  by 
) const

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

Since gtkmm 2.12:
Parameters
wxX coordinate relative to the widget.
wyY coordinate relative to the widget.
bxReturn location for bin_window X coordinate.
byReturn location for bin_window Y coordinate.
Cairo::RefPtr<Cairo::Surface> Gtk::IconView::create_drag_icon ( const TreeModel::Path path)

Creates a #cairo_surface_t representation of the item at path.

This image is used for a drag icon.

Since gtkmm 2.8:
Parameters
pathA Gtk::TreePath in icon_view.
Returns
A newly-allocated surface of the drag icon.
void Gtk::IconView::enable_model_drag_dest ( const std::vector< TargetEntry >&  targets,
Gdk::DragAction  actions = Gdk::ACTION_COPY|Gdk::ACTION_MOVE 
)

Turns the IconView into a drop destination for automatic DND.

Parameters
targetsThe table of targets that the drag will support.
actionsThe bitmask of possible actions for a drag from this widget.
void Gtk::IconView::enable_model_drag_source ( const std::vector< TargetEntry >&  targets,
Gdk::ModifierType  start_button_mask = Gdk::MODIFIER_MASK,
Gdk::DragAction  actions = Gdk::ACTION_COPY|Gdk::ACTION_MOVE 
)

Turns the IconView into a drag source for automatic DND.

Parameters
targetsStandard container of targets that the drag will support.
start_button_maskMask of allowed buttons to start drag.
actionsThe bitmask of possible actions for a drag from this widget.
bool Gtk::IconView::get_activate_on_single_click ( ) const

Gets the setting set by set_activate_on_single_click().

Since gtkmm 3.8:
Returns
true if item-activated will be emitted on a single click.
bool Gtk::IconView::get_cell_rect ( const TreeModel::Path path,
const CellRenderer cell,
Gdk::Rectangle rect 
) const

Fills the bounding rectangle in widget coordinates for the cell specified by path and cell.

If cell is nullptr the main cell area is used.

This function is only valid if icon_view is realized.

Since gtkmm 3.6:
Parameters
pathA Gtk::TreePath.
cellA Gtk::CellRenderer or nullptr.
rectRectangle to fill with cell rect.
Returns
false if there is no such item, true otherwise.
bool Gtk::IconView::get_cell_rect ( const TreeModel::Path path,
Gdk::Rectangle rect 
) const

A get_cell_rect() convenience overload.

int Gtk::IconView::get_column_spacing ( ) const

Returns the value of the property_column_spacing() property.

Since gtkmm 2.6:
Returns
The space between columns.
int Gtk::IconView::get_columns ( ) const

Returns the value of the property_columns() property.

Since gtkmm 2.6:
Returns
The number of columns, or -1.
bool Gtk::IconView::get_cursor ( TreeModel::Path path,
CellRenderer*&  cell 
) const

Fills in path and cell with the current cursor path and cell.

If the cursor isn't currently set, then path will be empty. If no cell currently has focus, then cell will be NULL.

Parameters
pathThe current cursor path.
cellThe current focus cell.
Returns
true if the cursor is set.
Since gtkmm 2.8:
bool Gtk::IconView::get_cursor ( TreeModel::Path path) const

Fills in path and cell with the current cursor path and cell.

If the cursor isn't currently set, then path will be empty. If no cell currently has focus, then cell will be NULL.

Parameters
pathThe current cursor path.
Returns
true if the cursor is set.
Since gtkmm 2.8:
bool Gtk::IconView::get_cursor ( CellRenderer*&  cell) const

Fills in path and cell with the current cursor path and cell.

If the cursor isn't currently set, then path will be empty. If no cell currently has focus, then cell will be NULL.

Parameters
cellThe current focus cell.
Returns
true if the cursor is set.
Since gtkmm 2.8:
bool Gtk::IconView::get_dest_item_at_pos ( int  drag_x,
int  drag_y,
TreeModel::Path path,
IconViewDropPosition pos 
) const

Determines the destination item for a given position.

Parameters
drag_xThe position to determine the destination item for.
drag_ythe position to determine the destination item for.
pathThe path of the item.
posThe drop position.
Returns
whether there is an item at the given position.
Since gtkmm 2.10:
bool Gtk::IconView::get_dest_item_at_pos ( int  drag_x,
int  drag_y,
TreeModel::Path path 
) const

Determines the destination item for a given position.

Parameters
drag_xThe position to determine the destination item for.
drag_ythe position to determine the destination item for.
pathThe path of the item.
Returns
whether there is an item at the given position.
Since gtkmm 2.10:
bool Gtk::IconView::get_dest_item_at_pos ( int  drag_x,
int  drag_y,
IconViewDropPosition pos 
) const

Determines the destination item for a given position.

Parameters
drag_xThe position to determine the destination item for.
drag_ythe position to determine the destination item for.
posThe drop position.
Returns
whether there is an item at the given position.
Since gtkmm 2.10:
void Gtk::IconView::get_drag_dest_item ( TreeModel::Path path,
IconViewDropPosition pos 
) const

Gets information about the item that is highlighted for feedback.

Parameters
pathThe highlighted item.
posThe drop position.
Since gtkmm 2.10:
void Gtk::IconView::get_drag_dest_item ( TreeModel::Path path) const

Gets information about the item that is highlighted for feedback.

Parameters
pathThe highlighted item.
Since gtkmm 2.10:
void Gtk::IconView::get_drag_dest_item ( IconViewDropPosition pos) const

Gets information about the item that is highlighted for feedback.

Parameters
posThe drop position.
Since gtkmm 2.10:
int Gtk::IconView::get_icon_width ( ) const

Returns the value of the property_item_width() property.

Since gtkmm 2.6:
Returns
The width of a single item, or -1.
bool Gtk::IconView::get_item_at_pos ( int  x,
int  y,
TreeModel::Path path,
CellRenderer*&  cell 
) const

Finds the path at the point (x, y), relative to widget coordinates.

Parameters
xThe x position to be identified.
yThe y position to be identified.
pathThe path.
cellThe renderer responsible for the cell at (x, y).
Returns
true if an item exists at the specified position.
Since gtkmm 2.6:
bool Gtk::IconView::get_item_at_pos ( int  x,
int  y,
TreeModel::Path path 
) const

Finds the path at the point (x, y), relative to widget coordinates.

Parameters
xThe x position to be identified.
yThe y position to be identified.
pathThe path.
Returns
true if an item exists at the specified position.
Since gtkmm 2.6:
bool Gtk::IconView::get_item_at_pos ( int  x,
int  y,
CellRenderer*&  cell 
) const

Finds the path at the point (x, y), relative to widget coordinates.

Parameters
xThe x position to be identified.
yThe y position to be identified.
cellThe renderer responsible for the cell at (x, y).
Returns
true if an item exists at the specified position.
Since gtkmm 2.6:
int Gtk::IconView::get_item_column ( const TreeModel::Path path) const

Gets the column in which the item path is currently displayed.

Column numbers start at 0.

Since gtkmm 2.22:
Parameters
pathThe Gtk::TreePath of the item.
Returns
The column in which the item is displayed.
Orientation Gtk::IconView::get_item_orientation ( ) const

Returns the value of the property_item_orientation() property which determines whether the labels are drawn beside the icons instead of below.

Since gtkmm 2.6:
Returns
The relative position of texts and icons.
int Gtk::IconView::get_item_padding ( ) const

Returns the value of the property_item_padding() property.

Since gtkmm 2.18:
Returns
The padding around items.
int Gtk::IconView::get_item_row ( const TreeModel::Path path) const

Gets the row in which the item path is currently displayed.

Row numbers start at 0.

Since gtkmm 2.22:
Parameters
pathThe Gtk::TreePath of the item.
Returns
The row in which the item is displayed.
int Gtk::IconView::get_margin ( ) const

Returns the value of the property_margin() property.

Since gtkmm 2.6:
Returns
The space at the borders.
int Gtk::IconView::get_markup_column ( ) const

Returns the column with markup text for icon_view.

Since gtkmm 2.6:
Returns
The markup column, or -1 if it’s unset.
Glib::RefPtr<TreeModel> Gtk::IconView::get_model ( )

Returns the model the Gtk::IconView is based on.

Returns nullptr if the model is unset.

Since gtkmm 2.6:
Returns
A Gtk::TreeModel, or nullptr if none is currently being used.
Glib::RefPtr<const TreeModel> Gtk::IconView::get_model ( ) const

Returns the model the Gtk::IconView is based on.

Returns nullptr if the model is unset.

Since gtkmm 2.6:
Returns
A Gtk::TreeModel, or nullptr if none is currently being used.
TreeModel::Path Gtk::IconView::get_path_at_pos ( int  x,
int  y 
) const

Finds the path at the point ( x, y), relative to bin_window coordinates.

See get_item_at_pos(), if you are also interested in the cell at the specified position. See convert_widget_to_bin_window_coords() for converting widget coordinates to bin_window coordinates.

Since gtkmm 2.6:
Parameters
xThe x position to be identified.
yThe y position to be identified.
Returns
The Gtk::TreePath corresponding to the icon or nullptr if no icon exists at that position.
int Gtk::IconView::get_pixbuf_column ( ) const

Returns the column with pixbufs for icon_view.

Since gtkmm 2.6:
Returns
The pixbuf column, or -1 if it’s unset.
bool Gtk::IconView::get_reorderable ( ) const

Retrieves whether the user can reorder the list via drag-and-drop.

See set_reorderable().

Since gtkmm 2.8:
Returns
true if the list can be reordered.
gint Gtk::IconView::get_row_spacing ( ) const

Returns the value of the property_row_spacing() property.

Since gtkmm 2.6:
Returns
The space between rows.
std::vector<TreePath> Gtk::IconView::get_selected_items ( ) const

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 Gtk::TreeRowReferences. To do this, you can use Gtk::TreeRowReference::new().

To free the return value, use:

[C example ellipted]

Since gtkmm 2.6:
Returns
A List containing a Gtk::TreePath for each selected row.
SelectionMode Gtk::IconView::get_selection_mode ( ) const

Gets the selection mode of the icon_view.

Since gtkmm 2.6:
Returns
The current selection mode.
int Gtk::IconView::get_spacing ( ) const

Returns the value of the property_spacing() property.

Since gtkmm 2.6:
Returns
The space between cells.
int Gtk::IconView::get_text_column ( ) const

Returns the column with text for icon_view.

Since gtkmm 2.6:
Returns
The text column, or -1 if it’s unset.
int Gtk::IconView::get_tooltip_column ( ) const

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

Since gtkmm 2.12:
Returns
The index of the tooltip column that is currently being used, or -1 if this is disabled.
bool Gtk::IconView::get_tooltip_context_iter ( int &  x,
int &  y,
bool  keyboard_tip,
Gtk::TreeModel::iterator iter 
)
Parameters
xthe x coordinate (relative to widget coordinates)
ythe y coordinate (relative to widget coordinates)
keyboard_tipwhether this is a keyboard tooltip or not
itera pointer to receive a Gtk::TreeIter

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

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

Return value: whether or not the given tooltip context points to a item.

Since gtkmm 2.12:
bool Gtk::IconView::get_tooltip_context_path ( int &  x,
int &  y,
bool  keyboard_tip,
TreeModel::Path path 
)
Parameters
xthe x coordinate (relative to widget coordinates)
ythe y coordinate (relative to widget coordinates)
keyboard_tipwhether this is a keyboard tooltip or not
patha reference to receive a Gtk::TreePath

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

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

Return value: whether or not the given tooltip context points to a item.

Since gtkmm 2.12:
static GType Gtk::IconView::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

bool Gtk::IconView::get_visible_range ( TreeModel::Path start_path,
TreeModel::Path end_path 
) const
GtkIconView* Gtk::IconView::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkIconView* Gtk::IconView::gobj ( ) const
inline

Provides access to the underlying C GObject.

void Gtk::IconView::item_activated ( const TreeModel::Path path)

Activates the item determined by path.

Since gtkmm 2.6:
Parameters
pathThe Gtk::TreePath to be activated.
virtual void Gtk::IconView::on_item_activated ( const TreeModel::Path path)
protectedvirtual

This is a default handler for the signal signal_item_activated().

virtual void Gtk::IconView::on_selection_changed ( )
protectedvirtual

This is a default handler for the signal signal_selection_changed().

IconView& Gtk::IconView::operator= ( IconView&&  src)
noexcept
IconView& Gtk::IconView::operator= ( const IconView )
delete
bool Gtk::IconView::path_is_selected ( const TreeModel::Path path) const

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 gtkmm 2.6:
Parameters
pathA Gtk::TreePath to check selection on.
Returns
true if path is selected.
Glib::PropertyProxy< bool > Gtk::IconView::property_activate_on_single_click ( )

The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click.

Since gtkmm 3.8:

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::IconView::property_activate_on_single_click ( ) const

The activate-on-single-click property specifies whether the "item-activated" signal will be emitted after a single click.

Since gtkmm 3.8:

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<CellArea> > Gtk::IconView::property_cell_area ( ) const

The Gtk::CellArea used to layout cell renderers for this view.

If no area is specified when creating the icon view with Gtk::IconView::new_with_area() a Gtk::CellAreaBox will be used.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_column_spacing ( )

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_column_spacing ( ) const

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_columns ( ) const

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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Orientation > Gtk::IconView::property_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 gtkmm 2.6:

Default value: Gtk::ORIENTATION_VERTICAL

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Orientation > Gtk::IconView::property_item_orientation ( ) const

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 gtkmm 2.6:

Default value: Gtk::ORIENTATION_VERTICAL

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_item_padding ( )

The item-padding property specifies the padding around each of the icon view's item.

Since gtkmm 2.18:

Default value: 6

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_item_padding ( ) const

The item-padding property specifies the padding around each of the icon view's item.

Since gtkmm 2.18:

Default value: 6

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_item_width ( ) const

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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_margin ( )

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_margin ( ) const

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_markup_column ( )

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_markup_column ( ) const

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<TreeModel> > Gtk::IconView::property_model ( )

The model for the icon view.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TreeModel> > Gtk::IconView::property_model ( ) const

The model for the icon view.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_pixbuf_column ( )

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_pixbuf_column ( ) const

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_reorderable ( )

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

Since gtkmm 2.8:

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_reorderable ( ) const

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

Since gtkmm 2.8:

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_row_spacing ( )

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_row_spacing ( ) const

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

Since gtkmm 2.6:

Default value: 6

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< SelectionMode > Gtk::IconView::property_selection_mode ( )

The property_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 gtkmm 2.6:

Default value: Gtk::SELECTION_SINGLE

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< SelectionMode > Gtk::IconView::property_selection_mode ( ) const

The property_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 gtkmm 2.6:

Default value: Gtk::SELECTION_SINGLE

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_spacing ( )

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

Since gtkmm 2.6:

Default value: 0

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_spacing ( ) const

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

Since gtkmm 2.6:

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_text_column ( )

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_text_column ( ) const

The property_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 gtkmm 2.6:

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::IconView::property_tooltip_column ( )

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

Default value: -1

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::IconView::property_tooltip_column ( ) const

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

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::IconView::scroll_to_path ( const TreeModel::Path path,
bool  use_align,
gfloat  row_align,
gfloat  col_align 
)

Moves the alignments of icon_view to the position specified by path.

row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

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

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

Since gtkmm 2.8:
Parameters
pathThe path of the item to move to.
use_alignWhether to use alignment arguments, or false.
row_alignThe vertical alignment of the item specified by path.
col_alignThe horizontal alignment of the item specified by path.
void Gtk::IconView::select_all ( )

Selects all the icons.

icon_view must has its selection mode set to Gtk::SELECTION_MULTIPLE.

Since gtkmm 2.6:
void Gtk::IconView::select_path ( const TreeModel::Path path)

Selects the row at path.

Since gtkmm 2.6:
Parameters
pathThe Gtk::TreePath to be selected.
void Gtk::IconView::selected_foreach ( const SlotForeach slot)

Calls a function for each selected icon.

Note that the model or selection cannot be modified from within this function.

Parameters
slotThe callback to call for each selected icon.
void Gtk::IconView::set_activate_on_single_click ( bool  single = true)

Causes the Gtk::IconView::signal_item_activated() signal to be emitted on a single click instead of a double click.

Since gtkmm 3.8:
Parameters
singletrue to emit item-activated on a single click.
void Gtk::IconView::set_column_spacing ( int  column_spacing)

Sets the property_column_spacing() property which specifies the space which is inserted between the columns of the icon view.

Since gtkmm 2.6:
Parameters
column_spacingThe column spacing.
void Gtk::IconView::set_columns ( int  columns)

Sets the property_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 gtkmm 2.6:
Parameters
columnsThe number of columns.
void Gtk::IconView::set_cursor ( const TreeModel::Path path,
CellRenderer cell,
bool  start_editing 
)

Sets the current keyboard focus to be at path, and selects it.

This is useful when you want to focus the user’s attention on a particular item. If cell is not nullptr, then focus is given to the cell specified by it. Additionally, if start_editing is true, then editing should be started in the specified cell.

This function is often followed by gtk_widget_grab_focus (icon_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

Since gtkmm 2.8:
Parameters
pathA Gtk::TreePath.
cellOne of the cell renderers of icon_view, or nullptr.
start_editingtrue if the specified cell should start being edited.
void Gtk::IconView::set_cursor ( const TreeModel::Path path,
bool  start_editing 
)

A set_cursor() convenience overload.

void Gtk::IconView::set_drag_dest_item ( const TreeModel::Path path,
IconViewDropPosition  pos 
)

Sets the item that is highlighted for feedback.

Since gtkmm 2.8:
Parameters
pathThe path of the item to highlight, or nullptr.
posSpecifies where to drop, relative to the item.
void Gtk::IconView::set_item_orientation ( Orientation  orientation)

Sets the property_item_orientation() property which determines whether the labels are drawn beside the icons instead of below.

Since gtkmm 2.6:
Parameters
orientationThe relative position of texts and icons.
void Gtk::IconView::set_item_padding ( int  item_padding)

Sets the Gtk::IconView::property_item_padding() property which specifies the padding around each of the icon view’s items.

Since gtkmm 2.18:
Parameters
item_paddingThe item padding.
void Gtk::IconView::set_item_width ( int  item_width)

Sets the property_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 gtkmm 2.6:
Parameters
item_widthThe width for each item.
void Gtk::IconView::set_margin ( int  margin)

Sets the property_margin() property which specifies the space which is inserted at the top, bottom, left and right of the icon view.

Since gtkmm 2.6:
Parameters
marginThe margin.
void Gtk::IconView::set_markup_column ( int  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 set_text_column().

Since gtkmm 2.6:
Parameters
columnA column in the currently used model, or -1 to display no text.
void Gtk::IconView::set_markup_column ( const TreeModelColumnBase 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 set_text_column().

Since gtkmm 2.6:
Parameters
columnA column in the currently used model, or -1 to display no text.
void Gtk::IconView::set_model ( const Glib::RefPtr< TreeModel >&  model)

Sets the model for a Gtk::IconView.

If the icon_view already has a model set, it will remove it before setting the new model. Use unset_model() to unset the old model.

Since gtkmm 2.6:
Parameters
modelThe model.
void Gtk::IconView::set_pixbuf_column ( int  column)

Sets the column with pixbufs for icon_view to be column.

The pixbuf column must be of type GDK_TYPE_PIXBUF

Since gtkmm 2.6:
Parameters
columnA column in the currently used model, or -1 to disable.
void Gtk::IconView::set_pixbuf_column ( const TreeModelColumnBase column)

Sets the column with pixbufs for icon_view to be column.

The pixbuf column must be of type GDK_TYPE_PIXBUF

Since gtkmm 2.6:
Parameters
columnA column in the currently used model, or -1 to disable.
void Gtk::IconView::set_reorderable ( bool  reorderable = true)

This function is a convenience function to allow you to reorder models that support the Gtk::TreeDragSourceIface and the Gtk::TreeDragDestIface.

Both Gtk::TreeStore and Gtk::ListStore 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.

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 gtkmm 2.8:
Parameters
reorderabletrue, if the list of items can be reordered.
void Gtk::IconView::set_row_spacing ( int  row_spacing)

Sets the property_row_spacing() property which specifies the space which is inserted between the rows of the icon view.

Since gtkmm 2.6:
Parameters
row_spacingThe row spacing.
void Gtk::IconView::set_selection_mode ( SelectionMode  mode)

Sets the selection mode of the icon_view.

Since gtkmm 2.6:
Parameters
modeThe selection mode.
void Gtk::IconView::set_spacing ( int  spacing)

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

Since gtkmm 2.6:
Parameters
spacingThe spacing.
void Gtk::IconView::set_text_column ( int  column)

Sets the column with text for icon_view to be column.

The text column must be of type G_TYPE_STRING.

Since gtkmm 2.6:
Parameters
columnA column in the currently used model, or -1 to display no text.
void Gtk::IconView::set_text_column ( const TreeModelColumnBase model_column)

Sets the column with text for icon_view to be model_column.

The text column must be of type G_TYPE_STRING.

Since gtkmm 2.6:
Parameters
model_columnA column in the currently used model, or -1 to display no text.
void Gtk::IconView::set_tooltip_cell ( const Glib::RefPtr< Tooltip >&  tooltip,
const TreeModel::Path path,
CellRenderer cell 
)

Sets the tip area of tooltip to the area which cell occupies in the item pointed to by path.

See also Tooltip::set_tip_area().

Since gtkmm 2.12:
Parameters
tooltipA Gtk::Tooltip.
pathA Gtk::TreePath.
cellA Gtk::CellRenderer.
void Gtk::IconView::set_tooltip_cell ( const Glib::RefPtr< Tooltip >&  tooltip,
const TreeModel::Path path 
)

Sets the tip area of tooltip to the area occupied by the item pointed to by path.

See also Tooltip::set_tip_area().

Since gtkmm 2.12:
Parameters
tooltipA Gtk::Tooltip.
pathA Gtk::TreePath.
void Gtk::IconView::set_tooltip_column ( int  column)

If you only plan to have simple (text-only) tooltips on full items, you can use this function to have Gtk::IconView handle these automatically for you.

column should be set to the column in icon_view’s model containing the tooltip texts, or -1 to disable this feature.

When enabled, Gtk::Widget::property_has_tooltip() will be set to true and icon_view will connect a Gtk::Widget::signal_query_tooltip() signal handler.

Note that the signal handler sets the text with Gtk::Tooltip::set_markup(), so&, <, etc have to be escaped in the text.

Since gtkmm 2.12:
Parameters
columnAn integer, which is a valid column number for icon_view’s model.
void Gtk::IconView::set_tooltip_item ( const Glib::RefPtr< Tooltip >&  tooltip,
const TreeModel::Path path 
)

Sets the tip area of tooltip to be the area covered by the item at path.

See also Tooltip::set_tip_area().

Since gtkmm 2.12:
Parameters
tooltipA Gtk::Tooltip.
pathA Gtk::TreePath.
Glib::SignalProxy< void,const TreeModel::Path& > Gtk::IconView::signal_item_activated ( )
Slot Prototype:
void on_my_item_activated(const TreeModel::Path& path)

Flags: Run Last

The signal_item_activated() signal is emitted when the method Gtk::IconView::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.

Parameters
pathThe Gtk::TreePath for the activated item.
Glib::SignalProxy< void > Gtk::IconView::signal_selection_changed ( )
Slot Prototype:
void on_my_selection_changed()

Flags: Run First

The signal_selection_changed() signal is emitted when the selection (i.e. the set of selected items) changes.

void Gtk::IconView::unselect_all ( )

Unselects all the icons.

Since gtkmm 2.6:
void Gtk::IconView::unselect_path ( const TreeModel::Path path)

Unselects the row at path.

Since gtkmm 2.6:
Parameters
pathThe Gtk::TreePath to be unselected.
void Gtk::IconView::unset_model ( )

Remove the model from the IconView.

See also
set_model().
Since gtkmm 2.16:
void Gtk::IconView::unset_model_drag_dest ( )

Undoes the effect of enable_model_drag_dest().

Calling this method sets Gtk::IconView::property_reorderable() to false.

Since gtkmm 2.8:
void Gtk::IconView::unset_model_drag_source ( )

Undoes the effect of enable_model_drag_source().

Calling this method sets Gtk::IconView::property_reorderable() to false.

Since gtkmm 2.8:

Friends And Related Function Documentation

Gtk::IconView* wrap ( GtkIconView *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.