gtkmm: Gtk::IconView Class Reference
The IconView provides an alternative view of a list model. More...
#include <gtkmm/iconview.h>
Public Member Functions | |
IconView (IconView&& src) noexcept | |
IconView& | operator= (IconView&& src) noexcept |
IconView (const IconView&)=delete | |
IconView& | operator= (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< TreeModel > | get_model () |
Returns the model the Gtk::IconView is based on. More... | |
Glib::RefPtr< const TreeModel > | get_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... | |
int | 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 |
Gets the path for the icon at the given position. 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 |
Sets start_path and end_path to be the first and last visible path. More... | |
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< TreePath > | get_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, float row_align, float col_align) |
Moves the alignments of icon_view to the position specified by path. More... | |
void | enable_model_drag_source (const Glib::RefPtr< const Gdk::ContentFormats >& formats, Gdk::ModifierType start_button_mask=static_cast< Gdk::ModifierType >(GDK_MODIFIER_MASK), Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE) |
Turns icon_view into a drag source for automatic DND. More... | |
void | enable_model_drag_dest (const Glib::RefPtr< const Gdk::ContentFormats >& formats, Gdk::DragAction actions=Gdk::DragAction::COPY|Gdk::DragAction::MOVE) |
Turns icon_view 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, DropPosition pos) |
Sets the item that is highlighted for feedback. More... | |
void | get_drag_dest_item (TreeModel::Path& path, DropPosition& 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 (DropPosition& 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, DropPosition& 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, DropPosition& pos) const |
Determines the destination item for a given position. More... | |
Glib::RefPtr< Gdk::Paintable > | create_drag_icon (const TreeModel::Path& path) const |
Creates a #cairo_surface_t representation of the item at path. 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) |
This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::IconView. More... | |
bool | get_tooltip_context_iter (int x, int y, bool keyboard_tip, Gtk::TreeModel::iterator& iter) |
This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::IconView. More... | |
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< SelectionMode > | property_selection_mode () |
The property_selection_mode() property specifies the selection mode of icon view. More... | |
Glib::PropertyProxy_ReadOnly< SelectionMode > | property_selection_mode () const |
The property_selection_mode() property specifies the selection mode of icon view. More... | |
Glib::PropertyProxy< Orientation > | 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. More... | |
Glib::PropertyProxy_ReadOnly< Orientation > | 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. 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::Widget | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (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... | |
Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
void | show () |
Flags a widget to be displayed. More... | |
void | hide () |
Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in paint phase of the current or the next frame. 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, int baseline) |
This is a simple form of allocate() that takes the new position of widget as part of allocation. More... | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
Measures widget in the orientation orientation and for the given for_size. 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 | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager set using set_layout_manager(). More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager set using set_layout_manager(). More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
void | set_can_focus (bool can_focus=true) |
Specifies whether the input focus can enter the widget or any of its children. More... | |
bool | get_can_focus () const |
Determines whether the input focus can enter widget or any of its children. More... | |
void | set_focusable (bool focusable=true) |
Specifies whether widget can own the input focus. More... | |
bool | get_focusable () 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... | |
bool | grab_focus () |
Causes widget (or one of its descendents) 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_target (bool can_target=true) |
Sets whether widget can be the target of pointer events. More... | |
bool | get_can_target () const |
Queries whether widget can be the target of pointer events. More... | |
bool | has_default () const |
Determines whether widget is the current default widget within its toplevel. 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... | |
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_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 | 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_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... | |
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... | |
Allocation | get_allocation () const |
Retrieves the widget’s location. More... | |
int | get_width () const |
Returns the content width of the widget, as passed to its size-allocate implementation. More... | |
int | get_height () const |
Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget, depending on orientation. More... | |
Widget* | get_parent () |
Returns the parent widget of widget. More... | |
const Widget* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
Native* | get_native () |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
const Native* | get_native () const |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. 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. 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_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_overflow (Overflow overflow) |
Sets how widget treats content that is drawn outside the widget's content area. More... | |
Overflow | get_overflow () const |
Returns the value set via set_overflow(). More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_ancestor (GType widget_type) const |
Gets the first ancestor of widget with type widget_type. 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::Display > | get_display () |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. 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... | |
bool | compute_expand (Orientation orientation) |
Computes whether a container should give this widget extra space when possible. More... | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. 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... | |
void | set_valign (Align align) |
Sets the vertical alignment 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... | |
void | set_margin (int margin) |
Set all 4 margins to the same value. 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, double src_x, double src_y, double& dest_x, double& dest_y) |
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
bool | contains (double x, double y) const |
Tests if the point at ( x, y) is contained in widget. More... | |
Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
void | add_controller (const Glib::RefPtr< EventController >& controller) |
Adds controller to widget so that it will receive events. More... | |
void | remove_controller (const Glib::RefPtr< EventController >& controller) |
Removes controller from widget, so that it doesn't process events anymore. More... | |
Glib::RefPtr< Pango::Context > | create_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::Context > | get_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::Layout > | create_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... | |
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 | set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor) |
Sets the cursor to be shown when pointer devices point towards widget. More... | |
void | set_cursor (const Glib::ustring& name={}) |
Sets a named cursor to be shown when pointer devices point towards the widget. More... | |
Glib::RefPtr< Gdk::Cursor > | get_cursor () |
Queries the cursor set via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set via set_cursor(). 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... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
This function is useful only when implementing subclasses of Gtk::Widget. 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 | 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 set using set_tooltip_markup(). 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... | |
bool | in_destruction () const |
Returns whether the widget is currently being destroyed. More... | |
Glib::RefPtr< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< const StyleContext > | get_style_context () const |
Returns the style context associated to widget. 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... | |
bool | activate_action (const Glib::ustring& name, const Glib::VariantBase& args={}) |
Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More... | |
void | activate_default () |
Activate the default.activate action from 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::FontMap > | get_font_map () |
Gets the font map that has been set with set_font_map(). More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map that has been set with set_font_map(). More... | |
Widget* | get_first_child () |
Returns the widgets first child. More... | |
const Widget* | get_first_child () const |
Returns the widgets first child. More... | |
Widget* | get_last_child () |
Returns the widgets last child. More... | |
const Widget* | get_last_child () const |
Returns the widgets last child. More... | |
Widget* | get_next_sibling () |
Returns the widgets next sibling. More... | |
const Widget* | get_next_sibling () const |
Returns the widgets next sibling. More... | |
Widget* | get_prev_sibling () |
Returns the widgets previous sibling. More... | |
const Widget* | get_prev_sibling () const |
Returns the widgets previous sibling. More... | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
void | insert_after (Widget& parent, const Widget& previous_sibling) |
Inserts the Widget into the child widget list of parent after previous_sibling. More... | |
void | insert_before (Widget& parent, const Widget& next_sibling) |
Inserts the Widget into the child widget list of parent before next_sibling. More... | |
void | insert_at_start (Widget& parent) |
Inserts the Widget at the beginning of the child widget list of parent. More... | |
void | insert_at_end (Widget& parent) |
Inserts the Widget at the end of the child widget list of parent. More... | |
void | snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
When a widget receives a call to the snapshot function, it must send synthetic Gtk::WidgetClass.snapshot() calls to all children. More... | |
bool | should_layout () const |
Returns whether widget should contribute to the measuring and allocation of its parent. More... | |
Glib::ustring | get_css_name () const |
Returns the CSS name that is used for self. More... | |
void | add_css_class (const Glib::ustring& css_class) |
Adds css_class to widget. More... | |
void | remove_css_class (const Glib::ustring& css_class) |
Removes css_class from widget. More... | |
bool | has_css_class (const Glib::ustring& css_class) const |
Returns whether css_class is currently applied to widget. More... | |
std::vector< Glib::ustring > | get_css_classes () const |
Returns the list of css classes applied to widget. More... | |
void | set_css_classes (const std::vector< Glib::ustring >& classes) |
Will clear all css classes applied to widget and replace them with classes. 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(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_parent () const |
The parent widget of this widget. More... | |
Glib::PropertyProxy_ReadOnly< Root* > | property_root () const |
The Gtk::Root widget of the widget tree containing this widget or nullptr if the widget is not contained in a root 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_can_focus () |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy< bool > | property_can_target () |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
Whether the widget can receive pointer events. 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_focusable () |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focusable () const |
Whether this widget itself will accept the input focus. 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< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
The cursor used by widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
The cursor used by widget. 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::ustring > | property_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::ustring > | property_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::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space, see Gtk::Align. 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< 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< 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< Overflow > | property_overflow () |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. More... | |
Glib::PropertyProxy< std::vector< Glib::ustring > > | property_css_classes () |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > | property_css_classes () const |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > | property_layout_manager () |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Public Member Functions inherited from Gtk::Object | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (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::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (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 |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (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) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
Public Member Functions inherited from Gtk::Accessible | |
Accessible (Accessible&& src) noexcept | |
Accessible& | operator= (Accessible&& src) noexcept |
~Accessible () noexcept override | |
GtkAccessible* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkAccessible* | gobj () const |
Provides access to the underlying C GObject. More... | |
Role | get_accessible_role () const |
Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More... | |
void | update_state (State state, const Glib::ValueBase& value) |
Updates an accessible state. More... | |
void | update_property (Property property, const Glib::ValueBase& value) |
Updates an accessible property. More... | |
void | update_relation (Relation relation, const Glib::ValueBase& value) |
Updates an accessible relation. More... | |
void | reset_state (State state) |
Resets the accessible state to its default value. More... | |
void | reset_property (Property property) |
Resets the accessible property to its default value. More... | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. More... | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Gtk::Buildable | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (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... | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. More... | |
Public Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget (ConstraintTarget&& src) noexcept | |
ConstraintTarget& | operator= (ConstraintTarget&& src) noexcept |
~ConstraintTarget () noexcept override | |
GtkConstraintTarget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkConstraintTarget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Public Member Functions inherited from Gtk::CellLayout | |
CellLayout (CellLayout&& src) noexcept | |
CellLayout& | operator= (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 () |
Returns the cell renderers which have been added to cell_layout. More... | |
std::vector< const CellRenderer* > | get_cells () const |
Returns the cell renderers which have been added to cell_layout. More... | |
CellRenderer* | get_first_cell () |
Gets the CellRenderer for the first column if any has been added, or nullptr otherwise. More... | |
const CellRenderer* | get_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< CellArea > | get_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 CellArea > | get_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 | |
Scrollable& | operator= (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< Adjustment > | get_hadjustment () |
Retrieves the Gtk::Adjustment used for horizontal scrolling. More... | |
Glib::RefPtr< const Adjustment > | get_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< Adjustment > | get_vadjustment () |
Retrieves the Gtk::Adjustment used for vertical scrolling. More... | |
Glib::RefPtr< const Adjustment > | get_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... | |
Policy | get_hscroll_policy () const |
Gets the horizontal Gtk::Scrollable::Policy. More... | |
void | set_hscroll_policy (Policy policy) |
Sets the Gtk::Scrollable::Policy to determine whether horizontal scrolling should start below the minimum width or below the natural width. More... | |
Policy | get_vscroll_policy () const |
Gets the vertical Gtk::Scrollable::Policy. More... | |
void | set_vscroll_policy (Policy policy) |
Sets the Gtk::Scrollable::Policy 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 () |
Vertical Gtk::Adjustment of the scrollable widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > | property_vadjustment () const |
Vertical Gtk::Adjustment of the scrollable widget. More... | |
Glib::PropertyProxy< Policy > | property_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< Policy > | property_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< Policy > | property_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< Policy > | property_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::Widget | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. 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 Public Member Functions inherited from Gtk::Accessible | |
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::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 Gtk::ConstraintTarget | |
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::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... | |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::IconView* | wrap (GtkIconView* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Widget | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Accessible | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Buildable | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::ConstraintTarget | |
Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::CellLayout | |
Glib::RefPtr< Gtk::CellLayout > | wrap (GtkCellLayout* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Scrollable | |
Glib::RefPtr< Gtk::Scrollable > | wrap (GtkScrollable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Gtk::Widget | |
virtual void | root_vfunc () |
virtual void | unroot_vfunc () |
virtual void | size_allocate_vfunc (int width, int height, int baseline) |
virtual SizeRequestMode | get_request_mode_vfunc () const |
virtual void | measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
virtual bool | grab_focus_vfunc () |
virtual void | set_focus_child_vfunc (Widget* child) |
Sets the focused child of widget. More... | |
virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
virtual bool | contains_vfunc (double x, double y) const |
virtual void | snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
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 | realize_if_needed () |
void | set_focus_child (Widget& child) |
Set child as the current focus child of widget. More... | |
void | unset_focus_child () |
Unsets the focus child of the widget. More... | |
Widget* | get_focus_child () |
Returns the current focus child of widget. More... | |
const Widget* | get_focus_child () const |
Returns the current focus child of widget. More... | |
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_state_flags_changed (Gtk::StateFlags previous_state_flags) |
This is a default handler for the signal signal_state_flags_changed(). More... | |
virtual void | on_direction_changed (TextDirection direction) |
This is a default handler for the signal signal_direction_changed(). More... | |
virtual bool | on_mnemonic_activate (bool group_cycling) |
This is a default handler for the signal signal_mnemonic_activate(). More... | |
virtual bool | on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip) |
This is a default handler for the signal signal_query_tooltip(). More... | |
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 | |
ObjectBase & | operator= (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::Accessible | |
Accessible () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::Buildable | |
Buildable () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget () | |
You should derive from this class to use it. More... | |
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... | |
virtual bool | get_border_vfunc (Border& border) const |
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
using Gtk::IconView::SlotForeach = sigc::slot<void(const TreeModel::Path&)> |
For instance, void on_foreach(const Gtk::TreeModel::Path& path);.
Constructor & Destructor Documentation
|
noexcept |
|
delete |
|
overridenoexcept |
Gtk::IconView::IconView | ( | ) |
|
explicit |
|
explicit |
Member Function Documentation
Glib::RefPtr<Gdk::Paintable> Gtk::IconView::create_drag_icon | ( | const TreeModel::Path& | path | ) | const |
Creates a #cairo_surface_t representation of the item at path.
This image is used for a drag icon.
- Parameters
-
path A Gtk::TreePath in icon_view.
- Returns
- A newly-allocated surface of the drag icon.
void Gtk::IconView::enable_model_drag_dest | ( | const Glib::RefPtr< const Gdk::ContentFormats >& | formats, |
Gdk::DragAction | actions = Gdk::DragAction::COPY|Gdk::DragAction::MOVE |
||
) |
Turns icon_view into a drop destination for automatic DND.
Calling this method sets Gtk::IconView::property_reorderable() to false
.
- Parameters
-
formats The formats that the drag will support. actions The bitmask of possible actions for a drag to this widget.
void Gtk::IconView::enable_model_drag_source | ( | const Glib::RefPtr< const Gdk::ContentFormats >& | formats, |
Gdk::ModifierType | start_button_mask = static_cast< Gdk::ModifierType >(GDK_MODIFIER_MASK) , |
||
Gdk::DragAction | actions = Gdk::DragAction::COPY|Gdk::DragAction::MOVE |
||
) |
Turns icon_view into a drag source for automatic DND.
Calling this method sets Gtk::IconView::property_reorderable() to false
.
- Parameters
-
start_button_mask Mask of allowed buttons to start drag. formats The formats that the drag will support. actions The 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().
- 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.
- Parameters
-
path A Gtk::TreePath. cell A Gtk::CellRenderer or nullptr
.rect Rectangle 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.
- Returns
- The space between columns.
int Gtk::IconView::get_columns | ( | ) | const |
Returns the value of the property_columns() property.
- 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 nullptr.
- Parameters
-
[out] path The current cursor path. [out] cell The current focus cell.
- Returns
- true if the cursor is set.
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 nullptr.
- Parameters
-
[out] path The current cursor path.
- Returns
- true if the cursor is set.
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 nullptr.
- Parameters
-
[out] cell The current focus cell.
- Returns
- true if the cursor is set.
bool Gtk::IconView::get_dest_item_at_pos | ( | int | drag_x, |
int | drag_y, | ||
TreeModel::Path& | path, | ||
DropPosition& | pos | ||
) | const |
Determines the destination item for a given position.
- Parameters
-
drag_x The position to determine the destination item for. drag_y the position to determine the destination item for. [out] path The path of the item. [out] pos The drop position.
- Returns
- Whether there is an item at the given position.
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_x The position to determine the destination item for. drag_y the position to determine the destination item for. [out] path The path of the item.
- Returns
- Whether there is an item at the given position.
bool Gtk::IconView::get_dest_item_at_pos | ( | int | drag_x, |
int | drag_y, | ||
DropPosition& | pos | ||
) | const |
Determines the destination item for a given position.
- Parameters
-
drag_x The position to determine the destination item for. drag_y the position to determine the destination item for. [out] pos The drop position.
- Returns
- Whether there is an item at the given position.
void Gtk::IconView::get_drag_dest_item | ( | TreeModel::Path& | path, |
DropPosition& | pos | ||
) | const |
Gets information about the item that is highlighted for feedback.
- Parameters
-
[out] path The highlighted item. [out] pos The drop position.
void Gtk::IconView::get_drag_dest_item | ( | TreeModel::Path& | path | ) | const |
Gets information about the item that is highlighted for feedback.
- Parameters
-
[out] path The highlighted item.
void Gtk::IconView::get_drag_dest_item | ( | DropPosition& | pos | ) | const |
Gets information about the item that is highlighted for feedback.
- Parameters
-
[out] pos The drop position.
int Gtk::IconView::get_icon_width | ( | ) | const |
Returns the value of the property_item_width() property.
- 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
-
x The x position to be identified. y The y position to be identified. [out] path The path. [out] cell The renderer responsible for the cell at (x, y).
- Returns
- true if an item exists at the specified position.
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
-
x The x position to be identified. y The y position to be identified. [out] path The path.
- Returns
- true if an item exists at the specified position.
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
-
x The x position to be identified. y The y position to be identified. [out] cell The renderer responsible for the cell at (x, y).
- Returns
- true if an item exists at the specified position.
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.
- Parameters
-
path The 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.
- Returns
- The relative position of texts and icons.
int Gtk::IconView::get_item_padding | ( | ) | const |
Returns the value of the property_item_padding() property.
- 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.
- Parameters
-
path The 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.
- Returns
- The space at the borders.
int Gtk::IconView::get_markup_column | ( | ) | const |
Returns the column with markup text for icon_view.
- 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.
- 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.
- 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 |
Gets the path for the icon at the given position.
- Parameters
-
x The x position to be identified. y The 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.
- 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().
- Returns
true
if the list can be reordered.
int Gtk::IconView::get_row_spacing | ( | ) | const |
Returns the value of the property_row_spacing() property.
- 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]
- 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.
- Returns
- The current selection mode.
int Gtk::IconView::get_spacing | ( | ) | const |
Returns the value of the property_spacing() property.
- Returns
- The space between cells.
int Gtk::IconView::get_text_column | ( | ) | const |
Returns the column with text for icon_view.
- 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.
- 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 | ||
) |
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.
- Parameters
-
x The x coordinate (relative to widget coordinates) y The y coordinate (relative to widget coordinates) keyboard_tip Whether this is a keyboard tooltip or not [out] iter A reference to receive a Gtk::TreeModel::iterator
- Returns
- Whether or not the given tooltip context points to an item.
bool Gtk::IconView::get_tooltip_context_path | ( | int | x, |
int | y, | ||
bool | keyboard_tip, | ||
TreeModel::Path& | path | ||
) |
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.
- Parameters
-
x The x coordinate (relative to widget coordinates) y The y coordinate (relative to widget coordinates) keyboard_tip Whether this is a keyboard tooltip or not [out] path A reference to receive a Gtk::TreePath
- Returns
- Whether or not the given tooltip context points to an item.
|
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 |
Sets start_path and end_path to be the first and last visible path.
Note that there may be invisible paths in between.
- Parameters
-
[out] start_path Return location for start of region. [out] end_path Return location for end of region.
- Returns
true
if valid paths were placed in start_path and end_path.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
void Gtk::IconView::item_activated | ( | const TreeModel::Path& | path | ) |
Activates the item determined by path.
- Parameters
-
path The Gtk::TreePath to be activated.
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.
- Parameters
-
path A 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.
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.
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.
- 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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::SelectionMode::MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible.
Default value: Gtk::SelectionMode::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::SelectionMode::MULTIPLE, rubberband selection is enabled, for the other modes, only keyboard selection is possible.
Default value: Gtk::SelectionMode::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.
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.
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.
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.
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, | ||
float | row_align, | ||
float | 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.
- Parameters
-
path The path of the item to move to. use_align Whether to use alignment arguments, or false
.row_align The vertical alignment of the item specified by path. col_align The 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::SelectionMode::MULTIPLE.
void Gtk::IconView::select_path | ( | const TreeModel::Path& | path | ) |
Selects the row at path.
- Parameters
-
path The 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
-
slot The 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.
- Parameters
-
single true
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.
- Parameters
-
column_spacing The 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.
- Parameters
-
columns The 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.
- Parameters
-
path A Gtk::TreePath. cell One of the cell renderers of icon_view, or nullptr
.start_editing true
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, |
DropPosition | pos | ||
) |
Sets the item that is highlighted for feedback.
- Parameters
-
path The path of the item to highlight, or nullptr
.pos Specifies 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.
- Parameters
-
orientation The 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.
- Parameters
-
item_padding The 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.
- Parameters
-
item_width The 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.
- Parameters
-
margin The 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().
- Parameters
-
column A 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().
- Parameters
-
column A 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.
- Parameters
-
model The 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
- Parameters
-
column A 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
- Parameters
-
column A 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.
- Parameters
-
reorderable true
, 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.
- Parameters
-
row_spacing The row spacing.
void Gtk::IconView::set_selection_mode | ( | SelectionMode | mode | ) |
Sets the selection mode of the icon_view.
- Parameters
-
mode The 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.
- Parameters
-
spacing The 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.
- Parameters
-
column A 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.
- Parameters
-
model_column A 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().
- Parameters
-
tooltip A Gtk::Tooltip. path A Gtk::TreePath. cell A 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().
- Parameters
-
tooltip A Gtk::Tooltip. path A 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.
- Parameters
-
column An 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().
- Parameters
-
tooltip A Gtk::Tooltip. path A 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
-
path The 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.
void Gtk::IconView::unselect_path | ( | const TreeModel::Path& | path | ) |
Unselects the row at path.
- Parameters
-
path The Gtk::TreePath to be unselected.
void Gtk::IconView::unset_model | ( | ) |
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
.
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
.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False 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.