gtkmm: Gtk::TreeView Class Reference

The TreeView widget displays the model (Gtk::TreeModel) data and allows the user to interact with it. More...

#include <gtkmm/treeview.h>

Inheritance diagram for Gtk::TreeView:

Public Types

typedef TreeViewColumn Column
 A visible column in a Gtk::TreeView widget. More...

 
typedef TreeSelection Selection
 A selection object for Gtk::TreeView. More...

 
typedef TreeViewColumn::SlotCellData SlotCellData
 
typedef TreeViewColumn::SlotTreeCellData SlotTreeCellData
 
typedef sigc::slot< bool, TreeView*, TreeViewColumn*, TreeViewColumn*, TreeViewColumn* > SlotColumnDrop
 For instance, bool on_column_drop(TreeView*, tree_view, TreeViewColumn* column, TreeViewColumn* prev_column, TreeViewColumn* next_column) More...

 
typedef sigc::slot< void, TreeView*, const TreeModel::Path& > SlotMapping
 For example, void on_map_expanded_rows(TreeView* tree_view, const TreeModel::Path& path);. More...

 
typedef sigc::slot< bool, const Glib::RefPtr< TreeModel >&, int, const Glib::ustring&, const TreeModel::iterator& > SlotSearchEqual
 void on_search_equal(const Glib::RefPtr<TreeModel>& model, int column, const Glib::ustring& key, const TreeModel::iterator& iter) More...

 
typedef sigc::slot< void, Gtk::Widget* > SlotSearchPosition
 void on_search_position(Gtk::Widget* search_dialog) More...

 
typedef sigc::slot< bool, const Glib::RefPtr< TreeModel >&, const TreeModel::iterator& > SlotRowSeparator
 The slot type for determining whether the row pointed to by the iterator should be rendered as a separator. More...

 
- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget& > ForeachSlot
 For instance, void on_foreach(Gtk::Widget* widget);. More...

 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 

Public Member Functions

 TreeView (TreeView&& src) noexcept
 
TreeViewoperator= (TreeView&& src) noexcept
 
 TreeView (const TreeView&)=delete
 
TreeViewoperator= (const TreeView&)=delete
 
 ~TreeView () noexceptoverride
 
GtkTreeView* gobj ()
 Provides access to the underlying C GtkObject. More...

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

 
 TreeView ()
 Default constructor. More...

 
 TreeView (const Glib::RefPtr< TreeModel >& model)
 Constructor that binds to a TreeModel. More...

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

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

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

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

 
Glib::RefPtr< TreeSelectionget_selection ()
 Gets the Gtk::TreeSelection associated with tree_view. More...

 
Glib::RefPtr< const TreeSelectionget_selection () const
 Gets the Gtk::TreeSelection associated with tree_view. More...

 
bool get_headers_visible () const
 Returns true if the headers on the tree_view are visible. More...

 
void set_headers_visible (bool headers_visible=true)
 Sets the visibility state of the headers. More...

 
void columns_autosize ()
 Resizes all columns to their optimal width. More...

 
bool get_headers_clickable () const
 Returns whether all header columns are clickable. More...

 
void set_headers_clickable (bool setting=true)
 Allow the column title buttons to be clicked. More...

 
void set_rules_hint (bool setting=true)
 Sets a hint for the theme to draw even/odd rows in the tree_view with different colors, also known as "zebra striping". More...

 
bool get_rules_hint () const
 Gets the setting set by set_rules_hint(). More...

 
void set_activate_on_single_click (bool single=true)
 Cause the Gtk::TreeView::signal_row_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...

 
int append_column (TreeViewColumn& column)
 Appends column to the list of columns. More...

 
template<class ColumnType >
int append_column (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column)
 Appends a View column with the appropriate CellRenderer for the Model column. More...

 
template<class ColumnType >
int append_column_numeric (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column, const Glib::ustring& format)
 Like append_column(), but only for numeric types, which will be displayed in the specified format. More...

 
template<class ColumnType >
int append_column_editable (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column)
 Appends a View column with the appropriate CellRenderer for the Model column. More...

 
template<class ColumnType >
int append_column_numeric_editable (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column, const Glib::ustring& format)
 Like append_column_editable(), but only for numeric types, which will be displayed in the specified format. More...

 
int append_column (const Glib::ustring& title, CellRenderer& cell)
 Creates a View column containing the CellRenderer, and appends it. More...

 
int remove_column (TreeViewColumn& column)
 Removes column from tree_view. More...

 
void remove_all_columns ()
 Removes all View columns. More...

 
int insert_column (TreeViewColumn& column, int position)
 This inserts the column into the tree_view at position. More...

 
int insert_column (const Glib::ustring& title, CellRenderer& cell, int position)
 Creates a View column containing the CellRenderer, and inserts it. More...

 
template<class ColumnType >
int insert_column (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column, int position)
 Inserts a View column with the appropriate CellRenderer for the Model column. More...

 
template<class ColumnType >
int insert_column_editable (const Glib::ustring& title, const TreeModelColumn< ColumnType >& model_column, int position)
 Inserts a View column with the appropriate CellRenderer for the Model column. More...

 
int insert_column_with_data_func (int position, const Glib::ustring& title, CellRenderer& cell, const SlotTreeCellData& slot)
 Inserts a new column into the TreeView with the given cell renderer and a SlotTreeCellData to set cell renderer attributes (normally using data from the model). More...

 
guint get_n_columns () const
 Queries the number of columns in the given tree_view. More...

 
TreeViewColumnget_column (int n)
 Gets the Gtk::TreeViewColumn at the given position in the #tree_view. More...

 
const TreeViewColumnget_column (int n) const
 Gets the Gtk::TreeViewColumn at the given position in the #tree_view. More...

 
CellRendererget_column_cell_renderer (int n)
 Gets the CellRenderer for that column. More...

 
const CellRendererget_column_cell_renderer (int n) const
 Gets the CellRenderer for that column. More...

 
std::vector< TreeViewColumn* > get_columns ()
 Returns a list of all the Gtk::TreeViewColumn s currently in tree_view. More...

 
std::vector< const TreeViewColumn* > get_columns () const
 Returns a list of all the Gtk::TreeViewColumn s currently in tree_view. More...

 
void move_column_after (TreeViewColumn& column, TreeViewColumn& base_column)
 Moves column to be after to base_column. More...

 
void move_column_to_start (TreeViewColumn& column)
 This method moves column to the first position in the view. More...

 
void set_expander_column (TreeViewColumn& column)
 Sets the column to draw the expander arrow at. More...

 
void reset_expander_column ()
 This method resets the expander arrow to the default - the first visible column. More...

 
TreeViewColumnget_expander_column ()
 Returns the column that is the current expander column. More...

 
const TreeViewColumnget_expander_column () const
 Returns the column that is the current expander column. More...

 
void set_column_drag_function (const SlotColumnDrop& slot)
 Sets a callback slot for determining where a column may be dropped when dragged. More...

 
void unset_column_drag_function ()
 See set_column_drag_function(). More...

 
void scroll_to_point (int tree_x, int tree_y)
 Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates. More...

 
void scroll_to_cell (const TreeModel::Path& path, TreeViewColumn& column, float row_align, float col_align)
 Moves the alignments of tree view to the position specified by column and path. More...

 
void scroll_to_cell (const TreeModel::Path& path, TreeViewColumn& column)
 Moves the alignments of tree view to the position specified by column and path. More...

 
void scroll_to_row (const TreeModel::Path& path, float row_align)
 Moves the alignments of tree view to the position specified by path. More...

 
void scroll_to_row (const TreeModel::Path& path)
 Moves the alignments of tree view to the position specified by path. More...

 
void scroll_to_column (TreeViewColumn& column, float col_align)
 Moves the alignments of tree view to the position specified by column. More...

 
void scroll_to_column (TreeViewColumn& column)
 Moves the alignments of tree view to the position specified by column. More...

 
void row_activated (const TreeModel::Path& path, TreeViewColumn& column)
 Activates the cell determined by path and column. More...

 
void expand_all ()
 Recursively expands all nodes in the tree_view. More...

 
void collapse_all ()
 Recursively collapses all visible, expanded nodes in tree_view. More...

 
void expand_to_path (const TreeModel::Path& path)
 Expands the row at path. More...

 
bool expand_row (const TreeModel::Path& path, bool open_all)
 Opens the row so its children are visible. More...

 
bool collapse_row (const TreeModel::Path& path)
 Collapses a row (hides its child rows, if they exist). More...

 
void map_expanded_rows (const SlotMapping& slot)
 Calls the callback slot on all expanded rows. More...

 
bool row_expanded (const TreeModel::Path& path)
 Returns true if the node pointed to by path is expanded in tree_view. 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 tree via drag-and-drop. More...

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

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

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

 
void get_cursor (TreeModel::Path& path, TreeViewColumn*& focus_column)
 Fills in path and focus_column with the current path and focus column. More...

 
Glib::RefPtr< Gdk::Windowget_bin_window ()
 Returns the window that tree_view renders to. More...

 
Glib::RefPtr< const Gdk::Windowget_bin_window () const
 Returns the window that tree_view renders to. More...

 
bool get_path_at_pos (int x, int y, TreeModel::Path& path, TreeViewColumn*& column, int& cell_x, int& cell_y) const
 Finds the path at the point (x, y), relative to bin_window coordinates (please see get_bin_window()). More...

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

 
void get_cell_area (const TreeModel::Path& path, TreeViewColumn& column, Gdk::Rectangle& rect) const
 Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column. More...

 
void get_background_area (const TreeModel::Path& path, TreeViewColumn& column, Gdk::Rectangle& rect) const
 Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column. More...

 
void get_visible_rect (Gdk::Rectangle& visible_rect) const
 Fills visible_rect with the currently-visible region of the buffer, in tree coordinates. More...

 
bool get_visible_range (TreeModel::Path& start_path, TreeModel::Path& end_path) const
 
bool is_blank_at_pos (int x, int y, TreePath& path, TreeViewColumn*& column, int& cell_x, int& cell_y) const
 
bool is_blank_at_pos (int x, int y) const
 
void enable_model_drag_source (const std::vector< TargetEntry >& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
 Turns the TreeView into a drag source for automatic DND. More...

 
void enable_model_drag_source (Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
 Turns the TreeView into a drag source for automatic DND. More...

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

 
void enable_model_drag_dest (Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
 Turns the TreeView into a drop destination for automatic DND. More...

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

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

 
void set_drag_dest_row (const TreeModel::Path& path, TreeViewDropPosition pos)
 Sets the row that is highlighted for feedback. More...

 
void unset_drag_dest_row ()
 Remove an existing highlight. More...

 
void get_drag_dest_row (TreeModel::Path& path, TreeViewDropPosition& pos) const
 Gets information about the row that is highlighted for feedback. More...

 
bool get_dest_row_at_pos (int drag_x, int drag_y, TreeModel::Path& path, TreeViewDropPosition& pos) const
 Determines the destination row for a given position. More...

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

 
void set_enable_search (bool enable_search=true)
 If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find"). More...

 
bool get_enable_search () const
 Returns whether or not the tree allows to start interactive searching by typing in text. More...

 
int get_search_column () const
 Gets the column searched on by the interactive search code. More...

 
void set_search_column (const TreeModelColumnBase& column)
 Sets column as the column where the interactive search code should search in for the current model. More...

 
void set_search_column (int column)
 Sets column as the column where the interactive search code should search in for the current model. More...

 
void set_search_equal_func (const SlotSearchEqual& slot)
 Sets the compare function for the interactive search capabilities. More...

 
Entryget_search_entry ()
 Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view. More...

 
const Entryget_search_entry () const
 Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view. More...

 
void set_search_entry (Entry& entry)
 Sets the entry which the interactive search code will use for this tree_view. More...

 
void set_search_position_func (const SlotSearchPosition& slot)
 
void convert_widget_to_tree_coords (int wx, int wy, int& tx, int& ty) const
 Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree). More...

 
void convert_tree_to_widget_coords (int tx, int ty, int& wx, int& wy) const
 Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates. More...

 
void convert_widget_to_bin_window_coords (int wx, int wy, int& bx, int& by) const
 Converts widget coordinates to coordinates for the bin_window (see get_bin_window()). More...

 
void convert_bin_window_to_widget_coords (int bx, int by, int& wx, int& wy) const
 Converts bin_window coordinates (see get_bin_window()) to widget relative coordinates. More...

 
void convert_tree_to_bin_window_coords (int tx, int ty, int& bx, int& by) const
 Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates. More...

 
void convert_bin_window_to_tree_coords (int bx, int by, int& tx, int& ty) const
 Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree). More...

 
void set_fixed_height_mode (bool enable=true)
 Enables or disables the fixed height mode of tree_view. More...

 
bool get_fixed_height_mode () const
 Returns whether fixed height mode is turned on for tree_view. More...

 
void set_hover_selection (bool hover=true)
 Enables or disables the hover selection mode of tree_view. More...

 
bool get_hover_selection () const
 Returns whether hover selection mode is turned on for tree_view. More...

 
void set_hover_expand (bool expand=true)
 Enables or disables the hover expansion mode of tree_view. More...

 
bool get_hover_expand () const
 Returns whether hover expansion mode is turned on for tree_view. More...

 
void set_rubber_banding (bool enable=true)
 Enables or disables rubber banding in tree_view. More...

 
bool get_rubber_banding () const
 Returns whether rubber banding is turned on for tree_view. More...

 
bool is_rubber_banding_active () const
 Returns whether a rubber banding operation is currently being done in tree_view. More...

 
void set_row_separator_func (const SlotRowSeparator& slot)
 Sets the row separator function, which is used to determine whether a row should be drawn as a separator. More...

 
void unset_row_separator_func ()
 Removes the row separator function, so no separators are drawn. More...

 
void set_grid_lines (TreeViewGridLines grid_lines)
 Sets which grid lines to draw in tree_view. More...

 
TreeViewGridLines get_grid_lines () const
 Returns which grid lines are enabled in tree_view. More...

 
void set_enable_tree_lines (bool enable=true)
 Sets whether to draw lines interconnecting the expanders in tree_view. More...

 
bool get_enable_tree_lines () const
 Returns whether or not tree lines are drawn in tree_view. More...

 
void set_show_expanders (bool enabled=true)
 Sets whether to draw and enable expanders and indent child rows in tree_view. More...

 
bool get_show_expanders () const
 Returns whether or not expanders are drawn in tree_view. More...

 
void set_level_indentation (int indentation)
 Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation. More...

 
int get_level_indentation () const
 Returns the amount, in pixels, of extra indentation for child levels in tree_view. More...

 
void set_tooltip_row (const Glib::RefPtr< Tooltip >& tooltip, const TreePath& path)
 Sets the tip area of tooltip to be the area covered by the row at path. More...

 
void set_tooltip_cell (const Glib::RefPtr< Tooltip >& tooltip, const TreeModel::Path* path, TreeViewColumn* column, CellRenderer* cell)
 Sets the tip area of tooltip to the area path, column and cell have in common. More...

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

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

 
Glib::SignalProxy< void, const TreeModel::Path&, TreeViewColumn* > signal_row_activated ()
 
Glib::SignalProxy< bool, const TreeModel::iterator&, const TreeModel::Path& > signal_test_expand_row ()
 
Glib::SignalProxy< bool, const TreeModel::iterator&, const TreeModel::Path& > signal_test_collapse_row ()
 
Glib::SignalProxy< void, const TreeModel::iterator&, const TreeModel::Path& > signal_row_expanded ()
 
Glib::SignalProxy< void, const TreeModel::iterator&, const TreeModel::Path& > signal_row_collapsed ()
 
Glib::SignalProxy< void > signal_cursor_changed ()
 
Glib::SignalProxy< void > signal_columns_changed ()
 
Glib::PropertyProxy< Glib::RefPtr< TreeModel > > property_model ()
 The model for the tree view. More...

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

 
Glib::PropertyProxy< bool > property_headers_visible ()
 Show the column header buttons. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_headers_visible () const
 Show the column header buttons. More...

 
Glib::PropertyProxy< bool > property_headers_clickable ()
 Column headers respond to click events. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_headers_clickable () const
 Column headers respond to click events. More...

 
Glib::PropertyProxy< TreeViewColumn* > property_expander_column ()
 Set the column for the expander column. More...

 
Glib::PropertyProxy_ReadOnly< TreeViewColumn* > property_expander_column () const
 Set the column for the expander column. More...

 
Glib::PropertyProxy< bool > property_reorderable ()
 View is reorderable. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_reorderable () const
 View is reorderable. More...

 
Glib::PropertyProxy< bool > property_rules_hint ()
 Sets a hint to the theme to draw rows in alternating colors. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_rules_hint () const
 Sets a hint to the theme to draw rows in alternating colors. More...

 
Glib::PropertyProxy< bool > property_enable_search ()
 View allows user to search through columns interactively. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_enable_search () const
 View allows user to search through columns interactively. More...

 
Glib::PropertyProxy< int > property_search_column ()
 Model column to search through during interactive search. More...

 
Glib::PropertyProxy_ReadOnly< int > property_search_column () const
 Model column to search through during interactive search. More...

 
Glib::PropertyProxy< bool > property_fixed_height_mode ()
 Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_fixed_height_mode () const
 Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height. More...

 
Glib::PropertyProxy< bool > property_hover_selection ()
 Enables or disables the hover selection mode of tree_view. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hover_selection () const
 Enables or disables the hover selection mode of tree_view. More...

 
Glib::PropertyProxy< bool > property_hover_expand ()
 Enables or disables the hover expansion mode of tree_view. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_hover_expand () const
 Enables or disables the hover expansion mode of tree_view. More...

 
Glib::PropertyProxy< bool > property_show_expanders ()
 true if the view has expanders. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_show_expanders () const
 true if the view has expanders. More...

 
Glib::PropertyProxy< bool > property_level_indentation ()
 Extra indentation for each level. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_level_indentation () const
 Extra indentation for each level. More...

 
Glib::PropertyProxy< bool > property_rubber_banding ()
 Whether to enable selection of multiple items by dragging the mouse pointer. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_rubber_banding () const
 Whether to enable selection of multiple items by dragging the mouse pointer. More...

 
Glib::PropertyProxy< bool > property_enable_grid_lines ()
 Whether grid lines should be drawn in the tree view. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_enable_grid_lines () const
 Whether grid lines should be drawn in the tree view. More...

 
Glib::PropertyProxy< bool > property_enable_tree_lines ()
 Whether tree lines should be drawn in the tree view. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_enable_tree_lines () const
 Whether tree lines should be drawn in the tree view. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 Gets widget’s parent window. More...

 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 Gets widget’s parent window. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::ustring& target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const std::vector< TargetEntry >& targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window >& proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 
void drag_dest_unset ()
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context, const Glib::RefPtr< TargetList >& target_list) const
 Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning Gdk::NONE. More...

 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext >& context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList >& target_list)
 
void drag_dest_add_text_targets ()
 
void drag_dest_add_image_targets ()
 
void drag_dest_add_uri_targets ()
 
void drag_source_set (const std::vector< TargetEntry >& targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 Undoes the effects of set(). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Static Public Member Functions

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

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

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

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

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

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

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

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

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

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

 

Protected Member Functions

virtual void on_row_activated (const TreeModel::Path& path, TreeViewColumn* column)
 This is a default handler for the signal signal_row_activated(). More...

 
virtual bool on_test_expand_row (const TreeModel::iterator& iter, const TreeModel::Path& path)
 This is a default handler for the signal signal_test_expand_row(). More...

 
virtual bool on_test_collapse_row (const TreeModel::iterator& iter, const TreeModel::Path& path)
 This is a default handler for the signal signal_test_collapse_row(). More...

 
virtual void on_row_expanded (const TreeModel::iterator& iter, const TreeModel::Path& path)
 This is a default handler for the signal signal_row_expanded(). More...

 
virtual void on_row_collapsed (const TreeModel::iterator& iter, const TreeModel::Path& path)
 This is a default handler for the signal signal_row_collapsed(). More...

 
virtual void on_cursor_changed ()
 This is a default handler for the signal signal_cursor_changed(). More...

 
virtual void on_columns_changed ()
 This is a default handler for the signal signal_columns_changed(). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Related Functions

(Note that these are not member functions.)

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

 

Additional Inherited Members

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

 

Detailed Description

The TreeView widget displays the model (Gtk::TreeModel) data and allows the user to interact with it.

The View can show all of the model's columns, or just some, and it can show them in various ways. You must provide the TreeModel in the constructor, or with set_model().

Add View columns with append_column(), append_column_editable(), append_column_numeric(), append_column_numeric_editable(), insert_column(), or insert_column_editable().

You can manipulate the selection by obtaining the Gtk::TreeView::Selection from get_selection().

Member Typedef Documentation

A visible column in a Gtk::TreeView widget.

A selection object for Gtk::TreeView.

For instance, bool on_column_drop(TreeView*, tree_view, TreeViewColumn* column, TreeViewColumn* prev_column, TreeViewColumn* next_column)

This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to the function are: the tree_view, the view Column being dragged, and the two view Columns determining the drop spot. If either of the view Column arguments for the drop spot are 0, then they indicate an edge.

For example, void on_map_expanded_rows(TreeView* tree_view, const TreeModel::Path& path);.

The slot type for determining whether the row pointed to by the iterator should be rendered as a separator.

Return true if the row is a separator. A common way to implement this is to have a boolean column in the model, whose values the slot returns.

For instance, bool on_row_separator(const Glib::RefPtr<Gtk::TreeModel>& model, const Gtk::TreeModel::iterator& iter);

void on_search_equal(const Glib::RefPtr<TreeModel>& model, int column, const Glib::ustring& key, const TreeModel::iterator& iter)

void on_search_position(Gtk::Widget* search_dialog)

Constructor & Destructor Documentation

Gtk::TreeView::TreeView ( TreeView&&  src)
noexcept
Gtk::TreeView::TreeView ( const TreeView )
delete
Gtk::TreeView::~TreeView ( )
overridenoexcept
Gtk::TreeView::TreeView ( )

Default constructor.

Gtk::TreeView::TreeView ( const Glib::RefPtr< TreeModel >&  model)
explicit

Constructor that binds to a TreeModel.

Member Function Documentation

int Gtk::TreeView::append_column ( TreeViewColumn column)

Appends column to the list of columns.

If tree_view has “fixed_height” mode enabled, then column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

Parameters
columnThe Gtk::TreeViewColumn to add.
Returns
The number of columns in tree_view after appending.
template <class ColumnType >
int Gtk::TreeView::append_column ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column 
)
inline

Appends a View column with the appropriate CellRenderer for the Model column.

The CellRenderer can only be created automatically for some basic column types, such as Glib::ustring, int, double, bool, and Gdk::Pixbuf. If the type is not supported then the following warning will be shown: GLib-GObject-WARNING**: unable to set property `text' of type `gchararray' from value of type `glibmm__CustomBoxed_t'.

If the default formatting is not sufficient, or the numeric type is not supported, then you could use append_column_numeric(). Or you could create the TreeView::Column and/or CellRenderer manually and use TreeViewColumn::set_cell_data_func() to provide a callback that converts the model value into a string representation with .

Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
Returns
The number of columns in the View after appending.
int Gtk::TreeView::append_column ( const Glib::ustring title,
CellRenderer cell 
)

Creates a View column containing the CellRenderer, and appends it.

template <class ColumnType >
int Gtk::TreeView::append_column_editable ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column 
)
inline

Appends a View column with the appropriate CellRenderer for the Model column.

The compiler will attempt to instantiate appropriate template code to automatically store user changes in the model. To intercept the user's change and implement non-default logic, or if the compiler can't instantiate appropriate code for your model type, you could use append_column() and connect a signal handler to the CellRenderer.

See also
append_column_numeric_editable().
Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
Returns
The number of columns in the View after appending.
template <class ColumnType >
int Gtk::TreeView::append_column_numeric ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column,
const Glib::ustring format 
)
inline

Like append_column(), but only for numeric types, which will be displayed in the specified format.

This convenience template uses TreeView::Column::set_cell_data_func(), so the numeric formatting will be deactivated if you specify your own cell_data callback by calling set_cell_data_func() again.

Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
formatA printf-style format, such as "%d", used to create a text representation of the number.
Returns
The number of columns in the View after appending.
template <class ColumnType >
int Gtk::TreeView::append_column_numeric_editable ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column,
const Glib::ustring format 
)
inline

Like append_column_editable(), but only for numeric types, which will be displayed in the specified format.

This convenience template uses TreeView::Column::set_cell_data_func(), so the numeric formatting will be deactivated if you specify your own cell_data callback by calling set_cell_data_func() again.

Note that the user's input will be interpreted as decimal (base 10), regardless of the format.

Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
formatA printf-style format, such as "%d", used to create a text representation of the number.
Returns
The number of columns in the View after appending.
void Gtk::TreeView::collapse_all ( )

Recursively collapses all visible, expanded nodes in tree_view.

bool Gtk::TreeView::collapse_row ( const TreeModel::Path path)

Collapses a row (hides its child rows, if they exist).

Parameters
pathPath to a row in the tree_view.
Returns
true if the row was collapsed.
void Gtk::TreeView::columns_autosize ( )

Resizes all columns to their optimal width.

Only works after the treeview has been realized.

void Gtk::TreeView::convert_bin_window_to_tree_coords ( int  bx,
int  by,
int &  tx,
int &  ty 
) const

Converts bin_window coordinates to coordinates for the tree (the full scrollable area of the tree).

Since gtkmm 2.12:
Parameters
bxX coordinate relative to bin_window.
byY coordinate relative to bin_window.
txReturn location for tree X coordinate.
tyReturn location for tree Y coordinate.
void Gtk::TreeView::convert_bin_window_to_widget_coords ( int  bx,
int  by,
int &  wx,
int &  wy 
) const

Converts bin_window coordinates (see get_bin_window()) to widget relative coordinates.

Since gtkmm 2.12:
Parameters
bxBin_window X coordinate.
byBin_window Y coordinate.
wxReturn location for widget X coordinate.
wyReturn location for widget Y coordinate.
void Gtk::TreeView::convert_tree_to_bin_window_coords ( int  tx,
int  ty,
int &  bx,
int &  by 
) const

Converts tree coordinates (coordinates in full scrollable area of the tree) to bin_window coordinates.

Since gtkmm 2.12:
Parameters
txTree X coordinate.
tyTree Y coordinate.
bxReturn location for X coordinate relative to bin_window.
byReturn location for Y coordinate relative to bin_window.
void Gtk::TreeView::convert_tree_to_widget_coords ( int  tx,
int  ty,
int &  wx,
int &  wy 
) const

Converts tree coordinates (coordinates in full scrollable area of the tree) to widget coordinates.

Since gtkmm 2.12:
Parameters
txX coordinate relative to the tree.
tyY coordinate relative to the tree.
wxReturn location for widget X coordinate.
wyReturn location for widget Y coordinate.
void Gtk::TreeView::convert_widget_to_bin_window_coords ( int  wx,
int  wy,
int &  bx,
int &  by 
) const

Converts widget coordinates to coordinates for the bin_window (see get_bin_window()).

Since gtkmm 2.12:
Parameters
wxX coordinate relative to the widget.
wyY coordinate relative to the widget.
bxReturn location for bin_window X coordinate.
byReturn location for bin_window Y coordinate.
void Gtk::TreeView::convert_widget_to_tree_coords ( int  wx,
int  wy,
int &  tx,
int &  ty 
) const

Converts widget coordinates to coordinates for the tree (the full scrollable area of the tree).

Since gtkmm 2.12:
Parameters
wxX coordinate relative to the widget.
wyY coordinate relative to the widget.
txReturn location for tree X coordinate.
tyReturn location for tree Y coordinate.
Cairo::RefPtr<Cairo::Surface> Gtk::TreeView::create_row_drag_icon ( const TreeModel::Path path) const

Creates a #cairo_surface_t representation of the row at path.

This image is used for a drag icon.

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

Turns the TreeView into a drop destination for automatic DND.

Parameters
targetsThe table of targets that the drag will support.
actionsThe bitmask of possible actions for a drag from this widget.
void Gtk::TreeView::enable_model_drag_dest ( Gdk::DragAction  actions = Gdk::ACTION_COPY|Gdk::ACTION_MOVE)

Turns the TreeView into a drop destination for automatic DND.

This uses the default "GTK_TREE_MODEL_ROW" target, which the TreeView can handle automatically.

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

Turns the TreeView into a drag source for automatic DND.

Parameters
targetsStandard container of targets that the drag will support.
start_button_maskMask of allowed buttons to start drag.
actionsThe bitmask of possible actions for a drag from this widget.
void Gtk::TreeView::enable_model_drag_source ( Gdk::ModifierType  start_button_mask = Gdk::MODIFIER_MASK,
Gdk::DragAction  actions = Gdk::ACTION_COPY|Gdk::ACTION_MOVE 
)

Turns the TreeView into a drag source for automatic DND.

Parameters
start_button_maskMask of allowed buttons to start drag.
actionsThe bitmask of possible actions for a drag from this widget.
void Gtk::TreeView::expand_all ( )

Recursively expands all nodes in the tree_view.

bool Gtk::TreeView::expand_row ( const TreeModel::Path path,
bool  open_all 
)

Opens the row so its children are visible.

Parameters
pathPath to a row.
open_allWhether to recursively expand, or just expand immediate children.
Returns
true if the row existed and had children.
void Gtk::TreeView::expand_to_path ( const TreeModel::Path path)

Expands the row at path.

This will also expand all parent rows of path as necessary.

Since gtkmm 2.2:
Parameters
pathPath to a row.
bool Gtk::TreeView::get_activate_on_single_click ( ) const

Gets the setting set by set_activate_on_single_click().

Since gtkmm 3.8:
Returns
true if row-activated will be emitted on a single click.
void Gtk::TreeView::get_background_area ( const TreeModel::Path path,
TreeViewColumn column,
Gdk::Rectangle rect 
) const

Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column.

The returned rectangle is equivalent to the background_area passed to Gtk::CellRenderer::render(). These background areas tile to cover the entire tree window (except for the area used for header buttons). Contrast with the cell_area, returned by get_cell_area(), which returns only the cell itself, excluding surrounding borders and the tree expander area.

Parameters
pathA Gtk::TreePath for the row.
columnA Gtk::TreeViewColumn for the column.
rectRectangle to fill with cell background rect.
Glib::RefPtr<Gdk::Window> Gtk::TreeView::get_bin_window ( )

Returns the window that tree_view renders to.

This is used primarily to compare to event->window to confirm that the event on tree_view is on the right window.

Returns
A Gdk::Window, or nullptr when tree_view hasn’t been realized yet.
Glib::RefPtr<const Gdk::Window> Gtk::TreeView::get_bin_window ( ) const

Returns the window that tree_view renders to.

This is used primarily to compare to event->window to confirm that the event on tree_view is on the right window.

Returns
A Gdk::Window, or nullptr when tree_view hasn’t been realized yet.
void Gtk::TreeView::get_cell_area ( const TreeModel::Path path,
TreeViewColumn column,
Gdk::Rectangle rect 
) const

Fills the bounding rectangle in tree window coordinates for the cell at the row specified by path and the column specified by column.

If path points to a path not currently displayed, the y and height fields of the rectangle will be filled with 0. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the cell_area passed to Gtk::CellRenderer::render(). This function is only valid if #tree_view is realized.

Parameters
pathA Gtk::TreePath for the row.
columnA Gtk::TreeViewColumn for the column.
rectRectangle to fill with cell rect.
TreeViewColumn* Gtk::TreeView::get_column ( int  n)

Gets the Gtk::TreeViewColumn at the given position in the #tree_view.

Parameters
nThe position of the column, counting from 0.
Returns
The Gtk::TreeViewColumn, or nullptr if the position is outside the range of columns.
const TreeViewColumn* Gtk::TreeView::get_column ( int  n) const

Gets the Gtk::TreeViewColumn at the given position in the #tree_view.

Parameters
nThe position of the column, counting from 0.
Returns
The Gtk::TreeViewColumn, or nullptr if the position is outside the range of columns.
CellRenderer* Gtk::TreeView::get_column_cell_renderer ( int  n)

Gets the CellRenderer for that column.

You should dynamic_cast<> to the expected derived CellRenderer type. This assumes that the TreeViewColumn contains only one CellRenderer.

Parameters
nThe position of the view column.
Returns
The CellRenderer.
const CellRenderer* Gtk::TreeView::get_column_cell_renderer ( int  n) const

Gets the CellRenderer for that column.

You should dynamic_cast<> to the expected derived CellRenderer type. This assumes that the TreeViewColumn contains only one CellRenderer.

Parameters
nThe position of the view column.
Returns
The CellRenderer.
std::vector<TreeViewColumn*> Gtk::TreeView::get_columns ( )

Returns a list of all the Gtk::TreeViewColumn s currently in tree_view.

Returns
A list of Gtk::TreeViewColumn s.
std::vector<const TreeViewColumn*> Gtk::TreeView::get_columns ( ) const

Returns a list of all the Gtk::TreeViewColumn s currently in tree_view.

Returns
A list of Gtk::TreeViewColumn s.
void Gtk::TreeView::get_cursor ( TreeModel::Path path,
TreeViewColumn*&  focus_column 
)

Fills in path and focus_column with the current path and focus column.

Parameters
pathA reference to be filled with the current cursor path
focus_columnA reference to be filled with the current focus column
bool Gtk::TreeView::get_dest_row_at_pos ( int  drag_x,
int  drag_y,
TreeModel::Path path,
TreeViewDropPosition pos 
) const

Determines the destination row for a given position.

Parameters
drag_xThe x position to determine the destination row for
drag_yThe y position to determine the destination row for
pathReturn location for the path of the highlighted row
posReturn location for the drop position
void Gtk::TreeView::get_drag_dest_row ( TreeModel::Path path,
TreeViewDropPosition pos 
) const

Gets information about the row that is highlighted for feedback.

Parameters
pathReturn location for the path of the highlighted row
posReturn location for the drop position
bool Gtk::TreeView::get_enable_search ( ) const

Returns whether or not the tree allows to start interactive searching by typing in text.

Returns
Whether or not to let the user search interactively.
bool Gtk::TreeView::get_enable_tree_lines ( ) const

Returns whether or not tree lines are drawn in tree_view.

Since gtkmm 2.10:
Returns
true if tree lines are drawn in tree_view, false otherwise.
TreeViewColumn* Gtk::TreeView::get_expander_column ( )

Returns the column that is the current expander column.

This column has the expander arrow drawn next to it.

Returns
The expander column.
const TreeViewColumn* Gtk::TreeView::get_expander_column ( ) const

Returns the column that is the current expander column.

This column has the expander arrow drawn next to it.

Returns
The expander column.
bool Gtk::TreeView::get_fixed_height_mode ( ) const

Returns whether fixed height mode is turned on for tree_view.

Since gtkmm 2.6:
Returns
true if tree_view is in fixed height mode.
TreeViewGridLines Gtk::TreeView::get_grid_lines ( ) const

Returns which grid lines are enabled in tree_view.

Since gtkmm 2.10:
Returns
A Gtk::TreeViewGridLines value indicating which grid lines are enabled.
bool Gtk::TreeView::get_headers_clickable ( ) const

Returns whether all header columns are clickable.

Since gtkmm 2.10:
Returns
true if all header columns are clickable, otherwise false.
bool Gtk::TreeView::get_headers_visible ( ) const

Returns true if the headers on the tree_view are visible.

Returns
Whether the headers are visible or not.
bool Gtk::TreeView::get_hover_expand ( ) const

Returns whether hover expansion mode is turned on for tree_view.

Since gtkmm 2.6:
Returns
true if tree_view is in hover expansion mode.
bool Gtk::TreeView::get_hover_selection ( ) const

Returns whether hover selection mode is turned on for tree_view.

Since gtkmm 2.6:
Returns
true if tree_view is in hover selection mode.
int Gtk::TreeView::get_level_indentation ( ) const

Returns the amount, in pixels, of extra indentation for child levels in tree_view.

Since gtkmm 2.12:
Returns
The amount of extra indentation for child levels in tree_view. A return value of 0 means that this feature is disabled.
Glib::RefPtr<TreeModel> Gtk::TreeView::get_model ( )

Returns the model the Gtk::TreeView 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::TreeView::get_model ( ) const

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

Returns nullptr if the model is unset.

Returns
A Gtk::TreeModel, or nullptr if none is currently being used.
guint Gtk::TreeView::get_n_columns ( ) const

Queries the number of columns in the given tree_view.

Since gtkmm 3.4:
Returns
The number of columns in the tree_view.
bool Gtk::TreeView::get_path_at_pos ( int  x,
int  y,
TreeModel::Path path,
TreeViewColumn*&  column,
int &  cell_x,
int &  cell_y 
) const

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

That is, x and y are relative to an events coordinates. x and y must come from an event on the TreeView only where event->window == get_bin_window(). It is primarily for things like popup menus. path will be filled with the TreeModel::Path at that point. column will be filled with the column at that point. cell_x and cell_y return the coordinates relative to the cell background (i.e. the background_area passed to Gtk::CellRenderer::render()). This method is only meaningful if the TreeView is realized.

For converting widget coordinates (eg. the ones you get from Widget::property_query_tooltip()), please see convert_widget_to_bin_window_coords().

Parameters
xThe x position to be identified (relative to bin_window).
yThe y position to be identified (relative to bin_window).
pathA reference to a TreeModel::Path to be filled in
columnA reference to a TreeViewColumn pointer to be filled in
cell_xA reference where the X coordinate relative to the cell can be placed
cell_yA reference where the Y coordinate relative to the cell can be placed
Returns
true if a row exists at that coordinate.
Since gtkmm 2.8:
bool Gtk::TreeView::get_path_at_pos ( int  x,
int  y,
TreeModel::Path path 
) const

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

That is, x and y are relative to an events coordinates. x and y must come from an event on the TreeView only where event->window == get_bin_window(). It is primarily for things like popup menus. path will be filled with the TreeModel::Path at that point. This method is only meaningful if the TreeView is realized.

For converting widget coordinates (eg. the ones you get from Widget::property_query_tooltip()), please see convert_widget_to_bin_window_coords().

Parameters
xThe x position to be identified (relative to bin_window).
yThe y position to be identified (relative to bin_window).
pathA reference to a TreeModel::Path to be filled in
Returns
true if a row exists at that coordinate.

newin{2,16}

bool Gtk::TreeView::get_reorderable ( ) const

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

See set_reorderable().

Returns
true if the tree can be reordered.
bool Gtk::TreeView::get_rubber_banding ( ) const

Returns whether rubber banding is turned on for tree_view.

If the selection mode is Gtk::SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

Since gtkmm 2.10:
Returns
true if rubber banding in tree_view is enabled.
bool Gtk::TreeView::get_rules_hint ( ) const

Gets the setting set by set_rules_hint().

Deprecated: 3.14

Deprecated:
Don't use this API. There is no replacement.
Returns
true if the hint is set.
int Gtk::TreeView::get_search_column ( ) const

Gets the column searched on by the interactive search code.

Returns
The column the interactive search code searches in.
Entry* Gtk::TreeView::get_search_entry ( )

Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view.

In case the built-in entry is being used, nullptr will be returned.

Since gtkmm 2.10:
Returns
The entry currently in use as search entry.
const Entry* Gtk::TreeView::get_search_entry ( ) const

Returns the Gtk::Entry which is currently in use as interactive search entry for tree_view.

In case the built-in entry is being used, nullptr will be returned.

Since gtkmm 2.10:
Returns
The entry currently in use as search entry.
Glib::RefPtr<TreeSelection> Gtk::TreeView::get_selection ( )

Gets the Gtk::TreeSelection associated with tree_view.

Returns
A Gtk::TreeSelection object.
Glib::RefPtr<const TreeSelection> Gtk::TreeView::get_selection ( ) const

Gets the Gtk::TreeSelection associated with tree_view.

Returns
A Gtk::TreeSelection object.
bool Gtk::TreeView::get_show_expanders ( ) const

Returns whether or not expanders are drawn in tree_view.

Since gtkmm 2.12:
Returns
true if expanders are drawn in tree_view, false otherwise.
int Gtk::TreeView::get_tooltip_column ( ) const

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

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

This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::TreeView. 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 tree view row at the given coordinates (true) or not (false) for mouse tooltips. For keyboard tooltips the row returned will be the cursor item. When true, then the iter which has been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to Gtk::TreeView's bin_window if keyboard_tooltip is false.

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

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

This function is supposed to be used in a Gtk::Widget::query-tooltip signal handler for Gtk::TreeView. 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 tree view row at the given coordinates (true) or not (false) for mouse tooltips. For keyboard tooltips the row returned will be the cursor item. When true, then the path which has been provided will be set to point to that row and the corresponding model. x and y will always be converted to be relative to Gtk::TreeView's bin_window if keyboard_tooltip is false.

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

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

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

bool Gtk::TreeView::get_visible_range ( TreeModel::Path start_path,
TreeModel::Path end_path 
) const
void Gtk::TreeView::get_visible_rect ( Gdk::Rectangle visible_rect) const

Fills visible_rect with the currently-visible region of the buffer, in tree coordinates.

Convert to bin_window coordinates with convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

Parameters
visible_rectRectangle to fill.
GtkTreeView* Gtk::TreeView::gobj ( )
inline

Provides access to the underlying C GtkObject.

const GtkTreeView* Gtk::TreeView::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

int Gtk::TreeView::insert_column ( TreeViewColumn column,
int  position 
)

This inserts the column into the tree_view at position.

If position is -1, then the column is inserted at the end. If tree_view has “fixed_height” mode enabled, then column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

Parameters
columnThe Gtk::TreeViewColumn to be inserted.
positionThe position to insert column in.
Returns
The number of columns in tree_view after insertion.
int Gtk::TreeView::insert_column ( const Glib::ustring title,
CellRenderer cell,
int  position 
)

Creates a View column containing the CellRenderer, and inserts it.

Parameters
titleThe text to be used in the title header of this column.
cellThe CellRenderer.
positionThe position at which the CellRenderer should be inserted.
Returns
The number of columns in the View after inserting.
template <class ColumnType >
int Gtk::TreeView::insert_column ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column,
int  position 
)
inline

Inserts a View column with the appropriate CellRenderer for the Model column.

Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
positionThe position at which the CellRenderer should be inserted.
Returns
The number of columns in the View after inserting.
template <class ColumnType >
int Gtk::TreeView::insert_column_editable ( const Glib::ustring title,
const TreeModelColumn< ColumnType >&  model_column,
int  position 
)
inline

Inserts a View column with the appropriate CellRenderer for the Model column.

The compiler will attempt to instantiate appropriate template code to automatically store user changes in the model. To intercept the user's change and implement non-default logic, or if the compiler can't instantiate appropriate code for your model type, you should use insert_column() and connect a signal handler to the CellRenderer.

Parameters
titleThe text to be used in the title header of this column.
model_columnThe column in the TreeModel that will be rendered by this View column.
positionThe position at which the CellRenderer should be inserted.
Returns
The number of columns in the View after inserting.
int Gtk::TreeView::insert_column_with_data_func ( int  position,
const Glib::ustring title,
CellRenderer cell,
const SlotTreeCellData slot 
)

Inserts a new column into the TreeView with the given cell renderer and a SlotTreeCellData to set cell renderer attributes (normally using data from the model).

Parameters
positionPosition to insert, -1 for append
titlecolumn title
cellcell renderer for column
slotfunction to set attributes of cell renderer
Returns
number of columns in the TreeView after the insert
bool Gtk::TreeView::is_blank_at_pos ( int  x,
int  y,
TreePath path,
TreeViewColumn*&  column,
int &  cell_x,
int &  cell_y 
) const
bool Gtk::TreeView::is_blank_at_pos ( int  x,
int  y 
) const
bool Gtk::TreeView::is_rubber_banding_active ( ) const

Returns whether a rubber banding operation is currently being done in tree_view.

Since gtkmm 2.12:
Returns
true if a rubber banding operation is currently being done in tree_view.
void Gtk::TreeView::map_expanded_rows ( const SlotMapping slot)

Calls the callback slot on all expanded rows.

Parameters
slotA callback function to be called.
void Gtk::TreeView::move_column_after ( TreeViewColumn column,
TreeViewColumn base_column 
)

Moves column to be after to base_column.

See also move_column_to_start().

Parameters
columnThe Gtk::TreeViewColumn to be moved.
base_columnThe Gtk::TreeViewColumn to be moved relative to.
void Gtk::TreeView::move_column_to_start ( TreeViewColumn column)

This method moves column to the first position in the view.

Parameters
columnThe view column that will be moved
virtual void Gtk::TreeView::on_columns_changed ( )
protectedvirtual

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

virtual void Gtk::TreeView::on_cursor_changed ( )
protectedvirtual

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

virtual void Gtk::TreeView::on_row_activated ( const TreeModel::Path path,
TreeViewColumn column 
)
protectedvirtual

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

virtual void Gtk::TreeView::on_row_collapsed ( const TreeModel::iterator iter,
const TreeModel::Path path 
)
protectedvirtual

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

virtual void Gtk::TreeView::on_row_expanded ( const TreeModel::iterator iter,
const TreeModel::Path path 
)
protectedvirtual

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

virtual bool Gtk::TreeView::on_test_collapse_row ( const TreeModel::iterator iter,
const TreeModel::Path path 
)
protectedvirtual

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

virtual bool Gtk::TreeView::on_test_expand_row ( const TreeModel::iterator iter,
const TreeModel::Path path 
)
protectedvirtual

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

TreeView& Gtk::TreeView::operator= ( TreeView&&  src)
noexcept
TreeView& Gtk::TreeView::operator= ( const TreeView )
delete
Glib::PropertyProxy< bool > Gtk::TreeView::property_activate_on_single_click ( )

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

Since gtkmm 3.8:
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::TreeView::property_activate_on_single_click ( ) const

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

Since gtkmm 3.8:
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< bool > Gtk::TreeView::property_enable_grid_lines ( )

Whether grid lines should be drawn in the tree 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< bool > Gtk::TreeView::property_enable_grid_lines ( ) const

Whether grid lines should be drawn in the tree 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< bool > Gtk::TreeView::property_enable_search ( )

View allows user to search through columns interactively.

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::TreeView::property_enable_search ( ) const

View allows user to search through columns interactively.

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< bool > Gtk::TreeView::property_enable_tree_lines ( )

Whether tree lines should be drawn in the tree 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< bool > Gtk::TreeView::property_enable_tree_lines ( ) const

Whether tree lines should be drawn in the tree 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< TreeViewColumn* > Gtk::TreeView::property_expander_column ( )

Set the column for the expander column.

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< TreeViewColumn* > Gtk::TreeView::property_expander_column ( ) const

Set the column for the expander column.

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< bool > Gtk::TreeView::property_fixed_height_mode ( )

Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height.

Only enable this option if all rows are the same height. Please see Gtk::TreeView::set_fixed_height_mode() for more information on this option.

Since gtkmm 2.4:
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::TreeView::property_fixed_height_mode ( ) const

Setting the property_fixed_height_mode() property to true speeds up Gtk::TreeView by assuming that all rows have the same height.

Only enable this option if all rows are the same height. Please see Gtk::TreeView::set_fixed_height_mode() for more information on this option.

Since gtkmm 2.4:
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< bool > Gtk::TreeView::property_headers_clickable ( )

Column headers respond to click events.

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::TreeView::property_headers_clickable ( ) const

Column headers respond to click events.

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< bool > Gtk::TreeView::property_headers_visible ( )

Show the column header buttons.

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::TreeView::property_headers_visible ( ) const

Show the column header buttons.

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< bool > Gtk::TreeView::property_hover_expand ( )

Enables or disables the hover expansion mode of tree_view.

Hover expansion makes rows expand or collapse if the pointer moves over them.

This mode is primarily intended for treeviews in popups, e.g. in Gtk::ComboBox or Gtk::EntryCompletion.

Since gtkmm 2.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< bool > Gtk::TreeView::property_hover_expand ( ) const

Enables or disables the hover expansion mode of tree_view.

Hover expansion makes rows expand or collapse if the pointer moves over them.

This mode is primarily intended for treeviews in popups, e.g. in Gtk::ComboBox or Gtk::EntryCompletion.

Since gtkmm 2.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< bool > Gtk::TreeView::property_hover_selection ( )

Enables or disables the hover selection mode of tree_view.

Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes Gtk::SELECTION_SINGLE and Gtk::SELECTION_BROWSE.

This mode is primarily intended for treeviews in popups, e.g. in Gtk::ComboBox or Gtk::EntryCompletion.

Since gtkmm 2.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< bool > Gtk::TreeView::property_hover_selection ( ) const

Enables or disables the hover selection mode of tree_view.

Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes Gtk::SELECTION_SINGLE and Gtk::SELECTION_BROWSE.

This mode is primarily intended for treeviews in popups, e.g. in Gtk::ComboBox or Gtk::EntryCompletion.

Since gtkmm 2.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< bool > Gtk::TreeView::property_level_indentation ( )

Extra indentation for each level.

Since gtkmm 2.12:
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::TreeView::property_level_indentation ( ) const

Extra indentation for each level.

Since gtkmm 2.12:
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::TreeView::property_model ( )

The model for the tree 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::TreeView::property_model ( ) const

The model for the tree 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< bool > Gtk::TreeView::property_reorderable ( )

View is reorderable.

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::TreeView::property_reorderable ( ) const

View is reorderable.

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< bool > Gtk::TreeView::property_rubber_banding ( )

Whether to enable selection of multiple items by dragging the mouse pointer.

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::TreeView::property_rubber_banding ( ) const

Whether to enable selection of multiple items by dragging the mouse pointer.

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< bool > Gtk::TreeView::property_rules_hint ( )

Sets a hint to the theme to draw rows in alternating colors.

Deprecated: 3.14: The theme is responsible for drawing rows using zebra striping

Deprecated:
Don't use this API. There is no replacement.
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::TreeView::property_rules_hint ( ) const

Sets a hint to the theme to draw rows in alternating colors.

Deprecated: 3.14: The theme is responsible for drawing rows using zebra striping

Deprecated:
Don't use this API. There is no replacement.
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::TreeView::property_search_column ( )

Model column to search through during interactive search.

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::TreeView::property_search_column ( ) const

Model column to search through during interactive search.

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< bool > Gtk::TreeView::property_show_expanders ( )

true if the view has expanders.

Since gtkmm 2.12:
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::TreeView::property_show_expanders ( ) const

true if the view has expanders.

Since gtkmm 2.12:
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::TreeView::property_tooltip_column ( )

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

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::TreeView::property_tooltip_column ( ) const

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

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::TreeView::remove_all_columns ( )

Removes all View columns.

int Gtk::TreeView::remove_column ( TreeViewColumn column)

Removes column from tree_view.

Parameters
columnThe Gtk::TreeViewColumn to remove.
Returns
The number of columns in tree_view after removing.
void Gtk::TreeView::reset_expander_column ( )

This method resets the expander arrow to the default - the first visible column.

See also
set_expander_column().
void Gtk::TreeView::row_activated ( const TreeModel::Path path,
TreeViewColumn column 
)

Activates the cell determined by path and column.

Parameters
pathThe Gtk::TreePath to be activated.
columnThe Gtk::TreeViewColumn to be activated.
bool Gtk::TreeView::row_expanded ( const TreeModel::Path path)

Returns true if the node pointed to by path is expanded in tree_view.

Parameters
pathA Gtk::TreePath to test expansion state.
Returns
true if #path is expanded.
void Gtk::TreeView::scroll_to_cell ( const TreeModel::Path path,
TreeViewColumn column,
float  row_align,
float  col_align 
)

Moves the alignments of tree view to the position specified by column and 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.

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

Parameters
pathThe path of the row to move to.
columnThe Gtk::TreeViewColumn to move horizontally to.
row_alignThe vertical alignment of the row specified by path.
col_alignThe horizontal alignment of the column specified by column.
void Gtk::TreeView::scroll_to_cell ( const TreeModel::Path path,
TreeViewColumn column 
)

Moves the alignments of tree view to the position specified by column and path.

The tree does the minimum amount of work to scroll the cell onto the screen. This means that the cell will be scrolled to the edge closest to it's current position. If the cell is currently visible on the screen, nothing is done.

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

Parameters
pathThe path of the row to move to.
columnThe Gtk::TreeViewColumn to move horizontally to.
void Gtk::TreeView::scroll_to_column ( TreeViewColumn column,
float  col_align 
)

Moves the alignments of tree view to the position specified by column.

col_align determines where the column is placed, and is expected to be between 0.0 and 1.0. 0.0 means left alignment, 1.0 means right alignment, 0.5 means center.

This function only works if the model is set. If the model changes before the tree view is realized, the centered path will be modified to reflect this change.

Parameters
columnThe Gtk::TreeViewColumn to move horizontally to.
col_alignThe horizontal alignment of the column specified by column.
void Gtk::TreeView::scroll_to_column ( TreeViewColumn column)

Moves the alignments of tree view to the position specified by column.

The tree does the minimum amount of work to scroll the column onto the screen. This means that the column will be scrolled to the edge closest to it's current position. If the column is currently visible on the screen, nothing is done.

This function only works if the model is set. If the model changes before the tree view is realized, the centered path will be modified to reflect this change.

Parameters
columnThe Gtk::TreeViewColumn to move horizontally to.
void Gtk::TreeView::scroll_to_point ( int  tree_x,
int  tree_y 
)

Scrolls the tree view such that the top-left corner of the visible area is tree_x, tree_y, where tree_x and tree_y are specified in tree coordinates.

The tree_view must be realized before this function is called. If it isn't, you probably want to be using scroll_to_cell().

If either tree_x or tree_y are -1, then that direction isn’t scrolled.

Parameters
tree_xX coordinate of new top-left pixel of visible area, or -1.
tree_yY coordinate of new top-left pixel of visible area, or -1.
void Gtk::TreeView::scroll_to_row ( const TreeModel::Path path,
float  row_align 
)

Moves the alignments of tree view to the position specified by path.

row_align determines where the row is placed, and is expected to be between 0.0 and 1.0. 0.0 means top alignment, 1.0 means bottom alignment, 0.5 means center.

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

Parameters
pathThe path of the row to move to.
row_alignThe vertical alignment of the row specified by path.
void Gtk::TreeView::scroll_to_row ( const TreeModel::Path path)

Moves the alignments of tree view to the position specified by path.

The tree does the minimum amount of work to scroll the row onto the screen. This means that the row will be scrolled to the edge closest to it's current position. If the row is currently visible on the screen, nothing is done.

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

Parameters
pathThe path of the row to move to.
void Gtk::TreeView::set_activate_on_single_click ( bool  single = true)

Cause the Gtk::TreeView::signal_row_activated() signal to be emitted on a single click instead of a double click.

Since gtkmm 3.8:
Parameters
singletrue to emit row-activated on a single click.
void Gtk::TreeView::set_column_drag_function ( const SlotColumnDrop slot)

Sets a callback slot for determining where a column may be dropped when dragged.

This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to the function are: the tree_view, the view Column being dragged, and the two view Columns determining the drop spot. If either of the view Column arguments for the drop spot are 0, then they indicate an edge.

See unset_column_drag_function().

Parameters
slotA callback function to determine which columns are reorderable.
void Gtk::TreeView::set_cursor ( const TreeModel::Path path,
TreeViewColumn focus_column,
bool  start_editing = false 
)

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 row. Focus is given to the column specified. 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( tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

Parameters
pathA Gtk::TreePath.
focus_columnA Gtk::TreeViewColumn.
start_editingtrue if the specified cell should start being edited.
void Gtk::TreeView::set_cursor ( const TreeModel::Path path,
TreeViewColumn focus_column,
CellRenderer focus_cell,
bool  start_editing = false 
)

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 row. If focus_column is not nullptr, then focus is given to the column specified by it. If focus_column and focus_cell are not nullptr, and focus_column contains 2 or more editable or activatable cells, then focus is given to the cell specified by focus_cell. Additionally, if focus_column is specified, and start_editing is true, then editing should be started in the specified cell. This function is often followed by gtk_widget_grab_focus ( tree_view) in order to give keyboard focus to the widget. Please note that editing can only happen when the widget is realized.

If path is invalid for model, the current cursor (if any) will be unset and the function will return without failing.

Since gtkmm 2.2:
Parameters
pathA Gtk::TreePath.
focus_columnA Gtk::TreeViewColumn, or nullptr.
focus_cellA Gtk::CellRenderer, or nullptr.
start_editingtrue if the specified cell should start being edited.
void Gtk::TreeView::set_cursor ( const TreeModel::Path path)

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 row. This function is often followed by Gtk::widget::grab_focus(tree_view) in order to give keyboard focus to the widget.

Parameters
pathA reference to cursor path.
void Gtk::TreeView::set_drag_dest_row ( const TreeModel::Path path,
TreeViewDropPosition  pos 
)

Sets the row that is highlighted for feedback.

See also unset_drag_dest_row().

Parameters
pathThe path of the row to highlight
posSpecifies whether to drop before, after or into the row
void Gtk::TreeView::set_enable_search ( bool  enable_search = true)

If enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").

Note that even if this is false, the user can still initiate a search using the “start-interactive-search” key binding.

Parameters
enable_searchtrue, if the user can search interactively.
void Gtk::TreeView::set_enable_tree_lines ( bool  enable = true)

Sets whether to draw lines interconnecting the expanders in tree_view.

This does not have any visible effects for lists.

Since gtkmm 2.10:
Parameters
enabletrue to enable tree line drawing, false otherwise.
void Gtk::TreeView::set_expander_column ( TreeViewColumn column)

Sets the column to draw the expander arrow at.

It must be in the TreeView. See also reset_expander_column().

Parameters
columnThe column to draw the expander arrow at.
void Gtk::TreeView::set_fixed_height_mode ( bool  enable = true)

Enables or disables the fixed height mode of tree_view.

Fixed height mode speeds up Gtk::TreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type Gtk::TREE_VIEW_COLUMN_FIXED.

Since gtkmm 2.6:
Parameters
enabletrue to enable fixed height mode.
void Gtk::TreeView::set_grid_lines ( TreeViewGridLines  grid_lines)

Sets which grid lines to draw in tree_view.

Since gtkmm 2.10:
Parameters
grid_linesA Gtk::TreeViewGridLines value indicating which grid lines to enable.
void Gtk::TreeView::set_headers_clickable ( bool  setting = true)

Allow the column title buttons to be clicked.

Parameters
settingtrue if the columns are clickable.
void Gtk::TreeView::set_headers_visible ( bool  headers_visible = true)

Sets the visibility state of the headers.

Parameters
headers_visibletrue if the headers are visible.
void Gtk::TreeView::set_hover_expand ( bool  expand = true)

Enables or disables the hover expansion mode of tree_view.

Hover expansion makes rows expand or collapse if the pointer moves over them.

Since gtkmm 2.6:
Parameters
expandtrue to enable hover selection mode.
void Gtk::TreeView::set_hover_selection ( bool  hover = true)

Enables or disables the hover selection mode of tree_view.

Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes Gtk::SELECTION_SINGLE and Gtk::SELECTION_BROWSE.

Since gtkmm 2.6:
Parameters
hovertrue to enable hover selection mode.
void Gtk::TreeView::set_level_indentation ( int  indentation)

Sets the amount of extra indentation for child levels to use in tree_view in addition to the default indentation.

The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.

Since gtkmm 2.12:
Parameters
indentationThe amount, in pixels, of extra indentation in tree_view.
void Gtk::TreeView::set_model ( const Glib::RefPtr< TreeModel >&  model)

Sets the model for a Gtk::TreeView.

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

Parameters
modelThe model.
void Gtk::TreeView::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 Gtk::TreeModel::signal_row_inserted() and Gtk::TreeModel::signal_row_deleted() signals. The reordering is implemented by setting up the tree 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
reorderabletrue, if the tree can be reordered.
void Gtk::TreeView::set_row_separator_func ( const SlotRowSeparator slot)

Sets the row separator function, which is used to determine whether a row should be drawn as a separator.

void Gtk::TreeView::set_rubber_banding ( bool  enable = true)

Enables or disables rubber banding in tree_view.

If the selection mode is Gtk::SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

Since gtkmm 2.10:
Parameters
enabletrue to enable rubber banding.
void Gtk::TreeView::set_rules_hint ( bool  setting = true)

Sets a hint for the theme to draw even/odd rows in the tree_view with different colors, also known as "zebra striping".

This function tells the GTK+ theme that the user interface for your application requires users to read across tree rows and associate cells with one another.

Do not use it just because you prefer the appearance of the ruled tree; that’s a question for the theme. Some themes will draw tree rows in alternating colors even when rules are turned off, and users who prefer that appearance all the time can choose those themes. You should call this function only as a semantic hint to the theme engine that your tree makes alternating colors useful from a functional standpoint (since it has lots of columns, generally).

Deprecated: 3.14

Deprecated:
Don't use this API. There is no replacement.
Parameters
settingtrue if the tree requires reading across rows.
void Gtk::TreeView::set_search_column ( const TreeModelColumnBase column)

Sets column as the column where the interactive search code should search in for the current model.

If the search column is set, users can use the “start-interactive-search” key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search.

Note that column refers to a column of the current model. The search column is reset to -1 when the model is changed.

Parameters
columnThe column of the model to search in, or -1 to disable searching.
void Gtk::TreeView::set_search_column ( int  column)

Sets column as the column where the interactive search code should search in for the current model.

If the search column is set, users can use the “start-interactive-search” key binding to bring up search popup. The enable-search property controls whether simply typing text will also start an interactive search.

Note that column refers to a column of the current model. The search column is reset to -1 when the model is changed.

Parameters
columnThe column of the model to search in, or -1 to disable searching.
void Gtk::TreeView::set_search_entry ( Entry entry)

Sets the entry which the interactive search code will use for this tree_view.

This is useful when you want to provide a search entry in our interface at all time at a fixed position. Passing nullptr for entry will make the interactive search code use the built-in popup entry again.

Since gtkmm 2.10:
Parameters
entryThe entry the interactive search code of tree_view should use or nullptr.
void Gtk::TreeView::set_search_equal_func ( const SlotSearchEqual slot)

Sets the compare function for the interactive search capabilities.

Parameters
slotThe compare function to use during the search
void Gtk::TreeView::set_search_position_func ( const SlotSearchPosition slot)
void Gtk::TreeView::set_show_expanders ( bool  enabled = true)

Sets whether to draw and enable expanders and indent child rows in tree_view.

When disabled there will be no expanders visible in trees and there will be no way to expand and collapse rows by default. Also note that hiding the expanders will disable the default indentation. You can set a custom indentation in this case using set_level_indentation(). This does not have any visible effects for lists.

Since gtkmm 2.12:
Parameters
enabledtrue to enable expander drawing, false otherwise.
void Gtk::TreeView::set_tooltip_cell ( const Glib::RefPtr< Tooltip >&  tooltip,
const TreeModel::Path path,
TreeViewColumn column,
CellRenderer cell 
)

Sets the tip area of tooltip to the area path, column and cell have in common.

For example if path is nullptr and column is set, the tip area will be set to the full area covered by column. See also Gtk::Tooltip::set_tip_area().

Note that if path is not specified and cell is set and part of a column containing the expander, the tooltip might not show and hide at the correct position. In such cases path must be set to the current node under the mouse cursor for this function to operate correctly.

See also set_tooltip_column() for a simpler alternative.

Since gtkmm 2.12:
Parameters
tooltipA Gtk::Tooltip.
pathA Gtk::TreePath or nullptr.
columnA Gtk::TreeViewColumn or nullptr.
cellA Gtk::CellRenderer or nullptr.
void Gtk::TreeView::set_tooltip_column ( int  column)

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

column should be set to the column in tree_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 tree_view will connect a Gtk::Widget::signal_query_tooltip() signal handler.

Note that the signal handler sets the text with Gtk::Tooltip::set_markup(), so&, <, etc have to be escaped in the text.

Since gtkmm 2.12:
Parameters
columnAn integer, which is a valid column number for tree_view’s model.
void Gtk::TreeView::set_tooltip_row ( const Glib::RefPtr< Tooltip >&  tooltip,
const TreePath path 
)

Sets the tip area of tooltip to be the area covered by the row at path.

See also set_tooltip_column() for a simpler alternative. See also Gtk::Tooltip::set_tip_area().

Since gtkmm 2.12:
Parameters
tooltipA Gtk::Tooltip.
pathA Gtk::TreePath.
Glib::SignalProxy< void > Gtk::TreeView::signal_columns_changed ( )
Slot Prototype:
void on_my_columns_changed()

The number of columns of the treeview has changed.

Glib::SignalProxy< void > Gtk::TreeView::signal_cursor_changed ( )
Slot Prototype:
void on_my_cursor_changed()

The position of the cursor (focused cell) has changed.

Glib::SignalProxy< void,const TreeModel::Path&,TreeViewColumn* > Gtk::TreeView::signal_row_activated ( )
Slot Prototype:
void on_my_row_activated(const TreeModel::Path& path, TreeViewColumn* column)

The "row-activated" signal is emitted when the method Gtk::TreeView::row_activated() is called, when the user double clicks a treeview row with the "activate-on-single-click" property set to false, or when the user single clicks a row when the "activate-on-single-click" property set to true. It is also emitted when a non-editable row is selected and one of the keys: Space, Shift+Space, Return or Enter is pressed.

For selection handling refer to the [tree widget conceptual overview][TreeWidget] as well as Gtk::TreeSelection.

Parameters
pathThe Gtk::TreePath for the activated row.
columnThe Gtk::TreeViewColumn in which the activation occurred.
Glib::SignalProxy< void,const TreeModel::iterator&,const TreeModel::Path& > Gtk::TreeView::signal_row_collapsed ( )
Slot Prototype:
void on_my_row_collapsed(const TreeModel::iterator& iter, const TreeModel::Path& path)

The given row has been collapsed (child nodes are hidden).

Parameters
iterThe tree iter of the collapsed row.
pathA tree path that points to the row.
Glib::SignalProxy< void,const TreeModel::iterator&,const TreeModel::Path& > Gtk::TreeView::signal_row_expanded ( )
Slot Prototype:
void on_my_row_expanded(const TreeModel::iterator& iter, const TreeModel::Path& path)

The given row has been expanded (child nodes are shown).

Parameters
iterThe tree iter of the expanded row.
pathA tree path that points to the row.
Glib::SignalProxy< bool,const TreeModel::iterator&,const TreeModel::Path& > Gtk::TreeView::signal_test_collapse_row ( )
Slot Prototype:
bool on_my_test_collapse_row(const TreeModel::iterator& iter, const TreeModel::Path& path)

The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.

Parameters
iterThe tree iter of the row to collapse.
pathA tree path that points to the row.
Returns
false to allow collapsing, true to reject.
Glib::SignalProxy< bool,const TreeModel::iterator&,const TreeModel::Path& > Gtk::TreeView::signal_test_expand_row ( )
Slot Prototype:
bool on_my_test_expand_row(const TreeModel::iterator& iter, const TreeModel::Path& path)

The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.

Parameters
iterThe tree iter of the row to expand.
pathA tree path that points to the row.
Returns
false to allow expansion, true to reject.
void Gtk::TreeView::unset_column_drag_function ( )

See set_column_drag_function().

After this method has been called, the TreeView reverts to the default behavior of allowing all columns to be dropped everywhere.

void Gtk::TreeView::unset_drag_dest_row ( )

Remove an existing highlight.

See set_drag_dest_row().

Since gtkmm 3.2:
void Gtk::TreeView::unset_model ( )

Remove the model from the TreeView.

See also
set_model().
Since gtkmm 2.8:
void Gtk::TreeView::unset_row_separator_func ( )

Removes the row separator function, so no separators are drawn.

See set_row_separator_func().

Since gtkmm 3.2:
void Gtk::TreeView::unset_rows_drag_dest ( )

Undoes the effect of enable_model_drag_source()

void Gtk::TreeView::unset_rows_drag_source ( )

Undoes the effect of enable_model_drag_source()

Friends And Related Function Documentation

Gtk::TreeView* wrap ( GtkTreeView *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.