Gtk::TreeView Class Reference

#include <treeview.h>

Inheritance diagram for Gtk::TreeView:

Public Types
typedef TreeViewColumn	Column
typedef TreeSelection	Selection
typedef TreeViewColumn::SlotCellData	SlotCellData
typedef sigc::slot< bool, TreeView *, TreeViewColumn *, TreeViewColumn *, TreeViewColumn * >	SlotColumnDrop
typedef sigc::slot< void, TreeView *, const TreeModel::Path & >	SlotMapping
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
Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget & >	ForeachSlot

Public Member Functions
virtual	~TreeView ()
GtkTreeView *	gobj ()
	Provides access to the underlying C GtkObject. More...
const GtkTreeView *	gobj () const
	Provides access to the underlying C GtkObject. More...
	TreeView ()
	TreeView (const Glib::RefPtr< TreeModel > &model)
Glib::RefPtr< TreeModel >	get_model ()
Glib::RefPtr< const TreeModel >	get_model () const
void	set_model (const Glib::RefPtr< TreeModel > &model)
void	unset_model ()
Glib::RefPtr< TreeSelection >	get_selection ()
Glib::RefPtr< const TreeSelection >	get_selection () const
Adjustment *	get_hadjustment ()
const Adjustment *	get_hadjustment () const
void	set_hadjustment (Adjustment &adjustment)
void	unset_hadjustment ()
Adjustment *	get_vadjustment ()
const Adjustment *	get_vadjustment () const
void	set_vadjustment (Adjustment &adjustment)
void	unset_vadjustment ()
bool	get_headers_visible () const
void	set_headers_visible (bool headers_visible=true)
void	columns_autosize ()
bool	get_headers_clickable () const
void	set_headers_clickable (bool setting=true)
void	set_rules_hint (bool setting=true)
bool	get_rules_hint () const
int	append_column (TreeViewColumn &column)
template<class ColumnType >
int	append_column (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column)
template<class ColumnType >
int	append_column_numeric (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column, const Glib::ustring &format)
template<class ColumnType >
int	append_column_editable (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column)
template<class ColumnType >
int	append_column_numeric_editable (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column, const Glib::ustring &format)
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)
void	remove_all_columns ()
	Removes all View columns. More...
int	insert_column (TreeViewColumn &column, int position)
int	insert_column (const Glib::ustring &title, CellRenderer &cell, int position)
template<class ColumnType >
int	insert_column (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column, int position)
template<class ColumnType >
int	insert_column_editable (const Glib::ustring &title, const TreeModelColumn< ColumnType > &model_column, int position)
int	insert_column_with_data_func (int position, const Glib::ustring &title, CellRenderer &cell, const SlotCellData &slot)
TreeViewColumn *	get_column (int n)
const TreeViewColumn *	get_column (int n) const
CellRenderer *	get_column_cell_renderer (int n)
const CellRenderer *	get_column_cell_renderer (int n) const
Glib::ListHandle< TreeViewColumn * >	get_columns ()
Glib::ListHandle< const TreeViewColumn * >	get_columns () const
void	move_column_after (TreeViewColumn &column, TreeViewColumn &base_column)
void	move_column_to_start (TreeViewColumn &column)
void	set_expander_column (TreeViewColumn &column)
void	reset_expander_column ()
TreeViewColumn *	get_expander_column ()
const TreeViewColumn *	get_expander_column () const
void	set_column_drag_function (const SlotColumnDrop &slot)
void	unset_column_drag_function ()
void	scroll_to_point (int tree_x, int tree_y)
void	scroll_to_cell (const TreeModel::Path &path, TreeViewColumn &column, float row_align, float col_align)
void	scroll_to_cell (const TreeModel::Path &path, TreeViewColumn &column)
void	scroll_to_row (const TreeModel::Path &path, float row_align)
void	scroll_to_row (const TreeModel::Path &path)
void	scroll_to_column (TreeViewColumn &column, float col_align)
void	scroll_to_column (TreeViewColumn &column)
void	row_activated (const TreeModel::Path &path, TreeViewColumn &column)
void	expand_all ()
void	collapse_all ()
void	expand_to_path (const TreeModel::Path &path)
bool	expand_row (const TreeModel::Path &path, bool open_all)
bool	collapse_row (const TreeModel::Path &path)
void	map_expanded_rows (const SlotMapping &slot)
bool	row_expanded (const TreeModel::Path &path)
void	set_reorderable (bool reorderable=true)
bool	get_reorderable () const
void	set_cursor (const TreeModel::Path &path, TreeViewColumn &focus_column, bool start_editing=false)
void	set_cursor (const TreeModel::Path &path, TreeViewColumn &focus_column, CellRenderer &focus_cell, bool start_editing=false)
void	set_cursor (const TreeModel::Path &path)
void	get_cursor (TreeModel::Path &path, TreeViewColumn *&focus_column)
Glib::RefPtr< Gdk::Window >	get_bin_window ()
Glib::RefPtr< const Gdk::Window >	get_bin_window () const
bool	get_path_at_pos (int x, int y, TreeModel::Path &path, TreeViewColumn *&column, int &cell_x, int &cell_y)
bool	get_path_at_pos (int x, int y, TreeModel::Path &path, TreeViewColumn *&column, int &cell_x, int &cell_y) const
bool	get_path_at_pos (int x, int y, TreeModel::Path &path) const
void	get_cell_area (const TreeModel::Path &path, TreeViewColumn &column, Gdk::Rectangle &rect)
void	get_cell_area (const TreeModel::Path &path, TreeViewColumn &column, Gdk::Rectangle &rect) const
void	get_background_area (const TreeModel::Path &path, TreeViewColumn &column, Gdk::Rectangle &rect)
void	get_background_area (const TreeModel::Path &path, TreeViewColumn &column, Gdk::Rectangle &rect) const
void	get_visible_rect (Gdk::Rectangle &visible_rect)
void	get_visible_rect (Gdk::Rectangle &visible_rect) const
void	widget_to_tree_coords (int wx, int wy, int &tx, int &ty)
void	widget_to_tree_coords (int wx, int wy, int &tx, int &ty) const
void	tree_to_widget_coords (int tx, int ty, int &wx, int &wy)
void	tree_to_widget_coords (int tx, int ty, int &wx, int &wy) const
bool	get_visible_range (TreeModel::Path &start_path, TreeModel::Path &end_path) const
void	enable_model_drag_source (const ArrayHandle_TargetEntry &targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
void	enable_model_drag_source (Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
void	enable_model_drag_dest (const ArrayHandle_TargetEntry &targets, Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
void	enable_model_drag_dest (Gdk::DragAction actions=Gdk::ACTION_COPY|Gdk::ACTION_MOVE)
void	unset_rows_drag_source ()
void	unset_rows_drag_dest ()
void	set_drag_dest_row (const TreeModel::Path &path, TreeViewDropPosition pos)
void	get_drag_dest_row (TreeModel::Path &path, TreeViewDropPosition &pos) const
bool	get_dest_row_at_pos (int drag_x, int drag_y, TreeModel::Path &path, TreeViewDropPosition &pos) const
Glib::RefPtr< Gdk::Pixmap >	create_row_drag_icon (const TreeModel::Path &path)
void	set_enable_search (bool enable_search=true)
bool	get_enable_search () const
int	get_search_column () const
void	set_search_column (const TreeModelColumnBase &column)
void	set_search_column (int column)
void	set_search_equal_func (const SlotSearchEqual &slot)
Entry *	get_search_entry ()
const Entry *	get_search_entry () const
void	set_search_entry (Entry &entry)
void	set_search_position_func (const SlotSearchPosition &slot)
void	convert_widget_to_tree_coords (int wx, int wy, int &tx, int &ty) const
void	convert_tree_to_widget_coords (int tx, int ty, int &wx, int &wy) const
void	convert_widget_to_bin_window_coords (int wx, int wy, int &bx, int &by) const
void	convert_bin_window_to_widget_coords (int bx, int by, int &wx, int &wy) const
void	convert_tree_to_bin_window_coords (int tx, int ty, int &bx, int &by) const
void	convert_bin_window_to_tree_coords (int bx, int by, int &tx, int &ty) const
void	set_fixed_height_mode (bool enable=true)
bool	get_fixed_height_mode () const
void	set_hover_selection (bool hover=true)
bool	get_hover_selection () const
void	set_hover_expand (bool expand=true)
bool	get_hover_expand () const
void	set_rubber_banding (bool enable=true)
bool	get_rubber_banding () const
bool	is_rubber_banding_active () const
void	set_row_separator_func (const SlotRowSeparator &slot)
void	set_grid_lines (TreeViewGridLines grid_lines)
TreeViewGridLines	get_grid_lines () const
void	set_enable_tree_lines (bool enable=true)
bool	get_enable_tree_lines () const
void	set_show_expanders (bool enabled=true)
bool	get_show_expanders () const
void	set_level_indentation (int indentation)
int	get_level_indentation () const
void	set_tooltip_row (const Glib::RefPtr< Tooltip > &tooltip, const TreePath &path)
void	set_tooltip_cell (const Glib::RefPtr< Tooltip > &tooltip, const TreeModel::Path *path, TreeViewColumn *column, CellRenderer *cell)
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)
int	get_tooltip_column () const
Glib::SignalProxy2< void, Adjustment *, Adjustment * >	signal_set_scroll_adjustments ()
Glib::SignalProxy2< void, const TreeModel::Path &, TreeViewColumn * >	signal_row_activated ()
Glib::SignalProxy2< bool, const TreeModel::iterator &, const TreeModel::Path & >	signal_test_expand_row ()
Glib::SignalProxy2< bool, const TreeModel::iterator &, const TreeModel::Path & >	signal_test_collapse_row ()
Glib::SignalProxy2< void, const TreeModel::iterator &, const TreeModel::Path & >	signal_row_expanded ()
Glib::SignalProxy2< void, const TreeModel::iterator &, const TreeModel::Path & >	signal_row_collapsed ()
Glib::SignalProxy0< void >	signal_cursor_changed ()
Glib::SignalProxy0< void >	signal_columns_changed ()
Glib::PropertyProxy< Glib::RefPtr< TreeModel > >	property_model ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > >	property_model () const
Glib::PropertyProxy< Adjustment * >	property_hadjustment ()
Glib::PropertyProxy_ReadOnly< Adjustment * >	property_hadjustment () const
Glib::PropertyProxy< Adjustment * >	property_vadjustment ()
Glib::PropertyProxy_ReadOnly< Adjustment * >	property_vadjustment () const
Glib::PropertyProxy< bool >	property_headers_visible ()
Glib::PropertyProxy_ReadOnly< bool >	property_headers_visible () const
Glib::PropertyProxy< bool >	property_headers_clickable ()
Glib::PropertyProxy_ReadOnly< bool >	property_headers_clickable () const
Glib::PropertyProxy< TreeViewColumn * >	property_expander_column ()
Glib::PropertyProxy_ReadOnly< TreeViewColumn * >	property_expander_column () const
Glib::PropertyProxy< bool >	property_reorderable ()
Glib::PropertyProxy_ReadOnly< bool >	property_reorderable () const
Glib::PropertyProxy< bool >	property_rules_hint ()
Glib::PropertyProxy_ReadOnly< bool >	property_rules_hint () const
Glib::PropertyProxy< bool >	property_enable_search ()
Glib::PropertyProxy_ReadOnly< bool >	property_enable_search () const
Glib::PropertyProxy< int >	property_search_column ()
Glib::PropertyProxy_ReadOnly< int >	property_search_column () const
Glib::PropertyProxy< bool >	property_fixed_height_mode ()
Glib::PropertyProxy_ReadOnly< bool >	property_fixed_height_mode () const
Glib::PropertyProxy< bool >	property_hover_selection ()
Glib::PropertyProxy_ReadOnly< bool >	property_hover_selection () const
Glib::PropertyProxy< bool >	property_hover_expand ()
Glib::PropertyProxy_ReadOnly< bool >	property_hover_expand () const
Glib::PropertyProxy< bool >	property_show_expanders ()
Glib::PropertyProxy_ReadOnly< bool >	property_show_expanders () const
Glib::PropertyProxy< bool >	property_level_indentation ()
Glib::PropertyProxy_ReadOnly< bool >	property_level_indentation () const
Glib::PropertyProxy< bool >	property_rubber_banding ()
Glib::PropertyProxy_ReadOnly< bool >	property_rubber_banding () const
Glib::PropertyProxy< bool >	property_enable_grid_lines ()
Glib::PropertyProxy_ReadOnly< bool >	property_enable_grid_lines () const
Glib::PropertyProxy< bool >	property_enable_tree_lines ()
Glib::PropertyProxy_ReadOnly< bool >	property_enable_tree_lines () const
Glib::PropertyProxy< int >	property_tooltip_column ()
Glib::PropertyProxy_ReadOnly< int >	property_tooltip_column () const
Glib::RefPtr< Gtk::TreeModel >	_get_base_model ()
	Get the treeview's model, but actually get the child model if it's a TreeModelFilter. More...
Public Member Functions inherited from Gtk::Container
virtual	~Container ()
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)
guint	get_border_width () const
virtual void	add (Widget &widget)
void	remove (Widget &widget)
void	set_resize_mode (ResizeMode resize_mode)
ResizeMode	get_resize_mode () const
void	check_resize ()
void	foreach (const ForeachSlot &slot)
Glib::ListHandle< Widget * >	get_children ()
	(internal) Operate on contained items (see foreach()) More...
Glib::ListHandle< const Widget * >	get_children () const
void	propagate_expose (Widget &child, GdkEventExpose *event)
void	set_focus_chain (const Glib::ListHandle< Widget * > &focusable_widgets)
bool	has_focus_chain () const
Glib::ListHandle< Widget * >	get_focus_chain ()
Glib::ListHandle< const Widget * >	get_focus_chain () const
void	unset_focus_chain ()
void	set_reallocate_redraws (bool needs_redraws=true)
void	set_focus_child (Widget &widget)
void	set_focus_vadjustment (Adjustment &adjustment)
Adjustment *	get_focus_vadjustment ()
const Adjustment *	get_focus_vadjustment () const
void	set_focus_hadjustment (Adjustment &adjustment)
Adjustment *	get_focus_hadjustment ()
const Adjustment *	get_focus_hadjustment () const
void	resize_children ()
GType	child_type () const
Glib::SignalProxy1< void, Widget * >	signal_add ()
Glib::SignalProxy1< void, Widget * >	signal_remove ()
Glib::SignalProxy0< void >	signal_check_resize ()
Glib::SignalProxy1< void, Widget * >	signal_set_focus_child ()
void	show_all_children (bool recursive=true)
Public Member Functions inherited from Gtk::Widget
virtual	~Widget ()
GtkWidget *	gobj ()
	Provides access to the underlying C GtkObject. More...
const GtkWidget *	gobj () const
	Provides access to the underlying C GtkObject. More...
bool	set_scroll_adjustments (Adjustment &hadjustment, Adjustment &vadjustment)
void	show ()
void	show_now ()
void	hide ()
void	show_all ()
void	hide_all ()
void	queue_draw ()
void	queue_draw_area (int x, int y, int width, int height)
void	queue_resize ()
Requisition	size_request () const
void	size_request (const Requisition &requisition)
void	size_allocate (const Allocation &allocation)
void	add_accelerator (const Glib::ustring &accel_signal, const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
bool	remove_accelerator (const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods)
void	set_accel_path (const Glib::ustring &accel_path, const Glib::RefPtr< AccelGroup > &accel_group)
bool	mnemonic_activate (bool group_cycling)
bool	event (GdkEvent *event)
int	send_expose (GdkEvent *event)
bool	send_focus_change (GdkEvent *event)
bool	activate ()
void	reparent (Widget &new_parent)
bool	intersect (const Gdk::Rectangle &area) const
bool	intersect (const Gdk::Rectangle &area, Gdk::Rectangle &intersection) const
Gdk::Region	region_intersect (const Gdk::Region &region) const
void	freeze_child_notify ()
void	child_notify (const Glib::ustring &child_property)
void	thaw_child_notify ()
void	set_can_focus (bool can_focus=true)
bool	get_can_focus () const
bool	can_focus () const
bool	has_focus () const
bool	is_focus () const
void	grab_focus ()
void	set_can_default (bool can_default=true)
bool	get_can_default () const
bool	can_default () const
bool	has_default () const
void	grab_default ()
void	set_receives_default (bool receives_default=true)
bool	get_receives_default () const
bool	has_grab () const
void	add_modal_grab ()
void	remove_modal_grab ()
void	set_name (const Glib::ustring &name)
void	unset_name ()
Glib::ustring	get_name () const
void	set_state (StateType state)
StateType	get_state () const
void	set_sensitive (bool sensitive=true)
bool	get_sensitive () const
bool	is_sensitive () const
void	set_visible (bool visible=true)
bool	get_visible () const
void	set_has_window (bool has_window=true)
bool	get_has_window () const
bool	get_is_toplevel () const
bool	get_is_drawable () const
bool	get_realized () const
bool	get_mapped () const
void	set_app_paintable (bool app_paintable=true)
bool	get_app_paintable () const
void	set_double_buffered (bool double_buffered=true)
bool	get_double_buffered () const
void	set_redraw_on_allocate (bool redraw_on_allocate=true)
void	set_child_visible (bool is_visible=true)
bool	get_child_visible () const
void	set_window (const Glib::RefPtr< Gdk::Window > &window)
Glib::RefPtr< Gdk::Window >	get_window ()
Glib::RefPtr< const Gdk::Window >	get_window () const
Allocation	get_allocation () const
void	set_allocation (const Allocation &allocation)
Container *	get_parent ()
const Container *	get_parent () const
Glib::RefPtr< Gdk::Window >	get_parent_window ()
Glib::RefPtr< const Gdk::Window >	get_parent_window () const
void	set_parent_window (const Glib::RefPtr< const Gdk::Window > &parent_window)
bool	child_focus (DirectionType direction)
bool	keynav_failed (DirectionType direction)
void	error_bell ()
void	set_size_request (int width=-1, int height=-1)
void	get_size_request (int &width, int &height) const
void	set_events (Gdk::EventMask events)
void	add_events (Gdk::EventMask events)
void	set_extension_events (Gdk::ExtensionMode mode)
Gdk::ExtensionMode	get_extension_events () const
Container *	get_toplevel ()
const Container *	get_toplevel () const
Widget *	get_ancestor (GType widget_type)
const Widget *	get_ancestor (GType widget_type) const
Glib::RefPtr< Gdk::Colormap >	get_colormap ()
Glib::RefPtr< Gdk::Visual >	get_visual ()
Glib::RefPtr< Gdk::Screen >	get_screen ()
Glib::RefPtr< const Gdk::Screen >	get_screen () const
bool	has_screen () const
Glib::RefPtr< Gdk::Display >	get_display ()
Glib::RefPtr< const Gdk::Display >	get_display () const
Glib::RefPtr< Gdk::Window >	get_root_window ()
Glib::RefPtr< const Gdk::Window >	get_root_window () const
Glib::RefPtr< Settings >	get_settings ()
Glib::RefPtr< Clipboard >	get_clipboard (const Glib::ustring &selection)
Glib::RefPtr< const Clipboard >	get_clipboard (const Glib::ustring &selection) const
Glib::RefPtr< Gdk::Pixmap >	get_snapshot (Gdk::Rectangle &clip_rect) const
Glib::RefPtr< Gdk::Pixmap >	get_snapshot () const
void	set_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
Gdk::EventMask	get_events () const
void	get_pointer (int &x, int &y) const
bool	is_ancestor (Widget &ancestor) const
bool	translate_coordinates (Widget &dest_widget, int src_x, int src_y, int &dest_x, int &dest_y)
bool	has_rc_style () const
void	set_style (const Glib::RefPtr< Style > &style)
void	unset_style ()
void	ensure_style ()
Glib::RefPtr< Style >	get_style ()
Glib::RefPtr< const Style >	get_style () const
void	modify_style (const Glib::RefPtr< RcStyle > &style)
Glib::RefPtr< RcStyle >	get_modifier_style ()
Glib::RefPtr< const RcStyle >	get_modifier_style () const
void	modify_fg (StateType state, const Gdk::Color &color)
void	modify_bg (StateType state, const Gdk::Color &color)
void	modify_bg_pixmap (StateType state, const Glib::ustring &pixmap_name)
void	modify_text (StateType state, const Gdk::Color &color)
void	modify_base (StateType state, const Gdk::Color &color)
void	modify_cursor (const Gdk::Color &primary, const Gdk::Color &secondary)
void	unset_cursor ()
	See modify_cursor(). More...
void	modify_font (const Pango::FontDescription &font_desc)
void	unset_fg (StateType state)
void	unset_bg (StateType state)
void	unset_text (StateType state)
void	unset_base (StateType state)
void	unset_font ()
template<class PropertyType >
void	get_style_property (const Glib::ustring &the_property_name, PropertyType &value) const
Glib::RefPtr< Pango::Context >	create_pango_context ()
Glib::RefPtr< Pango::Context >	get_pango_context ()
Glib::RefPtr< Pango::Layout >	create_pango_layout (const Glib::ustring &text)
Glib::RefPtr< Gdk::Pixbuf >	render_icon (const StockID &stock_id, IconSize size, const Glib::ustring &detail=Glib::ustring())
void	set_composite_name (const Glib::ustring &name)
void	unset_composite_name ()
Glib::ustring	get_composite_name () const
void	reset_rc_styles ()
void	set_direction (TextDirection dir)
TextDirection	get_direction ()
TextDirection	get_direction () const
void	shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
void	unset_shape_combine_mask ()
void	input_shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
void	unset_input_shape_combine_mask ()
void	reset_shapes ()
void	path (Glib::ustring &path, Glib::ustring &path_reversed)
	Compute a widget's path of the form "GtkWindow.MyLabel". More...
void	class_path (Glib::ustring &path, Glib::ustring &path_reversed)
Glib::ListHandle< Widget * >	list_mnemonic_labels ()
Glib::ListHandle< const Widget * >	list_mnemonic_labels () const
void	add_mnemonic_label (Widget &label)
void	remove_mnemonic_label (Widget &label)
void	drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, Glib::ustring &target, guint32 time)
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 ArrayHandle_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
Glib::ustring	drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context) const
Glib::RefPtr< TargetList >	drag_dest_get_target_list ()
Glib::RefPtr< const TargetList >	drag_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 ArrayHandle_TargetEntry &targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
void	drag_source_unset ()
void	drag_source_set_icon (const Glib::RefPtr< Gdk::Colormap > &colormap, const Glib::RefPtr< Gdk::Pixmap > &pixmap, const Glib::RefPtr< Gdk::Bitmap > &mask)
void	drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)
void	drag_source_set_icon (const StockID &stock_id)
void	drag_source_set_icon (const Glib::ustring &icon_name)
void	drag_source_add_text_targets ()
void	drag_source_add_uri_targets ()
void	drag_source_add_image_targets ()
Glib::RefPtr< Gdk::DragContext >	drag_begin (const Glib::RefPtr< TargetList > &targets, Gdk::DragAction actions, int button, GdkEvent *event)
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 ()
bool	get_no_show_all () const
void	set_no_show_all (bool no_show_all=true)
void	set_parent (Widget &parent)
void	unparent ()
void	map ()
void	unmap ()
void	draw_insertion_cursor (Glib::RefPtr< Gdk::Drawable > drawable, const Gdk::Rectangle &area, const Gdk::Rectangle &location, bool is_primary, TextDirection direction, bool draw_arrow=true)
void	set_tooltip_window (Window &window)
Window *	get_tooltip_window ()
void	trigger_tooltip_query ()
void	set_tooltip_text (const Glib::ustring &text)
Glib::ustring	get_tooltip_text () const
void	set_tooltip_markup (const Glib::ustring &markup)
Glib::ustring	get_tooltip_markup () const
void	set_has_tooltip (bool has_tooltip=TRUE)
bool	get_has_tooltip () const
bool	has_no_window () const
bool	is_realized () const
bool	is_mapped () const
bool	is_toplevel () const
bool	is_drawable () const
bool	is_visible () const
bool	sensitive () const
bool	app_paintable () const
bool	receives_default () const
bool	double_buffered () const
bool	parent_sensitive () const
bool	rc_style () const
bool	is_composite_child () const
WidgetFlags	get_flags () const
void	set_flags (WidgetFlags flags)
void	unset_flags (WidgetFlags flags)
Gtk::StateType	get_saved_state () const
int	get_width () const
int	get_height () const
bool	is_composited () const
Glib::RefPtr< Action >	get_action ()
Glib::RefPtr< const Action >	get_action () const
Requisition	get_requisition () const
Glib::SignalProxy0< void >	signal_show ()
Glib::SignalProxy0< void >	signal_hide ()
Glib::SignalProxy0< void >	signal_map ()
	Emitted on mapping of a widget to the screen. More...
Glib::SignalProxy0< void >	signal_unmap ()
Glib::SignalProxy0< void >	signal_realize ()
	Emitted on realization of a widget. More...
Glib::SignalProxy0< void >	signal_unrealize ()
Glib::SignalProxy1< void, Requisition * >	signal_size_request ()
Glib::SignalProxy1< void, Allocation & >	signal_size_allocate ()
Glib::SignalProxy1< void, Gtk::StateType >	signal_state_changed ()
Glib::SignalProxy1< void, Widget * >	signal_parent_changed ()
	Informs objects that their parent changed. More...
Glib::SignalProxy1< void, Widget * >	signal_hierarchy_changed ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gtk::Style > & >	signal_style_changed ()
Glib::SignalProxy1< void, TextDirection >	signal_direction_changed ()
Glib::SignalProxy1< void, bool >	signal_grab_notify ()
Glib::SignalProxy1< void, GParamSpec * >	signal_child_notify ()
Glib::SignalProxy1< bool, bool >	signal_mnemonic_activate ()
Glib::SignalProxy0< void >	signal_grab_focus ()
Glib::SignalProxy1< bool, DirectionType >	signal_focus ()
Glib::SignalProxy1< bool, GdkEvent * >	signal_event ()
Glib::SignalProxy1< void, GdkEvent * >	signal_event_after ()
Glib::SignalProxy1< bool, GdkEventButton * >	signal_button_press_event ()
Glib::SignalProxy1< bool, GdkEventButton * >	signal_button_release_event ()
Glib::SignalProxy1< bool, GdkEventScroll * >	signal_scroll_event ()
Glib::SignalProxy1< bool, GdkEventMotion * >	signal_motion_notify_event ()
Glib::SignalProxy1< bool, GdkEventAny * >	signal_delete_event ()
Glib::SignalProxy1< bool, GdkEventExpose * >	signal_expose_event ()
	Event triggered by window requiring a refresh. More...
Glib::SignalProxy1< bool, GdkEventKey * >	signal_key_press_event ()
Glib::SignalProxy1< bool, GdkEventKey * >	signal_key_release_event ()
Glib::SignalProxy1< bool, GdkEventCrossing * >	signal_enter_notify_event ()
Glib::SignalProxy1< bool, GdkEventCrossing * >	signal_leave_notify_event ()
Glib::SignalProxy1< bool, GdkEventConfigure * >	signal_configure_event ()
Glib::SignalProxy1< bool, GdkEventFocus * >	signal_focus_in_event ()
Glib::SignalProxy1< bool, GdkEventFocus * >	signal_focus_out_event ()
Glib::SignalProxy1< bool, GdkEventAny * >	signal_map_event ()
Glib::SignalProxy1< bool, GdkEventAny * >	signal_unmap_event ()
Glib::SignalProxy1< bool, GdkEventProperty * >	signal_property_notify_event ()
Glib::SignalProxy1< bool, GdkEventSelection * >	signal_selection_clear_event ()
Glib::SignalProxy1< bool, GdkEventSelection * >	signal_selection_request_event ()
Glib::SignalProxy1< bool, GdkEventSelection * >	signal_selection_notify_event ()
Glib::SignalProxy1< bool, GdkEventProximity * >	signal_proximity_in_event ()
Glib::SignalProxy1< bool, GdkEventProximity * >	signal_proximity_out_event ()
Glib::SignalProxy1< bool, GdkEventVisibility * >	signal_visibility_notify_event ()
Glib::SignalProxy1< bool, GdkEventClient * >	signal_client_event ()
Glib::SignalProxy1< bool, GdkEventAny * >	signal_no_expose_event ()
Glib::SignalProxy1< bool, GdkEventWindowState * >	signal_window_state_event ()
Glib::SignalProxy3< void, SelectionData &, guint, guint >	signal_selection_get ()
Glib::SignalProxy2< void, const SelectionData &, guint >	signal_selection_received ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & >	signal_drag_begin ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & >	signal_drag_end ()
Glib::SignalProxy4< void, const Glib::RefPtr< Gdk::DragContext > &, SelectionData &, guint, guint >	signal_drag_data_get ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & >	signal_drag_data_delete ()
Glib::SignalProxy2< bool, const Glib::RefPtr< Gdk::DragContext > &, DragResult >	signal_drag_failed ()
Glib::SignalProxy2< void, const Glib::RefPtr< Gdk::DragContext > &, guint >	signal_drag_leave ()
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint >	signal_drag_motion ()
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint >	signal_drag_drop ()
Glib::SignalProxy6< void, const Glib::RefPtr< Gdk::DragContext > &, int, int, const SelectionData &, guint, guint >	signal_drag_data_received ()
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::Screen > & >	signal_screen_changed ()
Glib::SignalProxy0< void >	signal_composited_changed ()
Glib::SignalProxy0< bool >	signal_popup_menu ()
Glib::SignalProxy4< bool, int, int, bool, const Glib::RefPtr< Tooltip > & >	signal_query_tooltip ()
Glib::SignalProxy1< bool, GdkEventGrabBroken * >	signal_grab_broken_event ()
Glib::SignalProxy1< bool, GdkEventExpose * >	signal_damage_event ()
Glib::PropertyProxy< Glib::ustring >	property_name ()
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
Glib::PropertyProxy< Container * >	property_parent ()
Glib::PropertyProxy_ReadOnly< Container * >	property_parent () const
Glib::PropertyProxy< int >	property_width_request ()
Glib::PropertyProxy_ReadOnly< int >	property_width_request () const
Glib::PropertyProxy< int >	property_height_request ()
Glib::PropertyProxy_ReadOnly< int >	property_height_request () const
Glib::PropertyProxy< bool >	property_visible ()
Glib::PropertyProxy_ReadOnly< bool >	property_visible () const
Glib::PropertyProxy< bool >	property_sensitive ()
Glib::PropertyProxy_ReadOnly< bool >	property_sensitive () const
Glib::PropertyProxy< bool >	property_app_paintable ()
Glib::PropertyProxy_ReadOnly< bool >	property_app_paintable () const
Glib::PropertyProxy< bool >	property_can_focus ()
Glib::PropertyProxy_ReadOnly< bool >	property_can_focus () const
Glib::PropertyProxy< bool >	property_has_focus ()
Glib::PropertyProxy_ReadOnly< bool >	property_has_focus () const
Glib::PropertyProxy< bool >	property_is_focus ()
Glib::PropertyProxy_ReadOnly< bool >	property_is_focus () const
Glib::PropertyProxy< bool >	property_can_default ()
Glib::PropertyProxy_ReadOnly< bool >	property_can_default () const
Glib::PropertyProxy< bool >	property_has_default ()
Glib::PropertyProxy_ReadOnly< bool >	property_has_default () const
Glib::PropertyProxy< bool >	property_receives_default ()
Glib::PropertyProxy_ReadOnly< bool >	property_receives_default () const
Glib::PropertyProxy_ReadOnly< bool >	property_composite_child () const
Glib::PropertyProxy< Glib::RefPtr< Style > >	property_style ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > >	property_style () const
Glib::PropertyProxy< Gdk::EventMask >	property_events ()
Glib::PropertyProxy_ReadOnly< Gdk::EventMask >	property_events () const
Glib::PropertyProxy< Gdk::ExtensionMode >	property_extension_events ()
Glib::PropertyProxy_ReadOnly< Gdk::ExtensionMode >	property_extension_events () const
Glib::PropertyProxy< bool >	property_has_tooltip ()
Glib::PropertyProxy_ReadOnly< bool >	property_has_tooltip () const
Glib::PropertyProxy< Glib::ustring >	property_tooltip_markup ()
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_tooltip_markup () const
Glib::PropertyProxy< Glib::ustring >	property_tooltip_text ()
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_tooltip_text () const
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > >	property_window () const
Glib::PropertyProxy< bool >	property_no_show_all ()
Glib::PropertyProxy_ReadOnly< bool >	property_no_show_all () const
Glib::PropertyProxy< bool >	property_double_buffered ()
Glib::PropertyProxy_ReadOnly< bool >	property_double_buffered () const
Public Member Functions inherited from Gtk::Object
virtual	~Object ()
GtkObject *	gobj ()
	Provides access to the underlying C GtkObject. More...
const GtkObject *	gobj () const
	Provides access to the underlying C GtkObject. More...
Glib::PropertyProxy< void * >	property_user_data ()
Glib::PropertyProxy_ReadOnly< void * >	property_user_data () const

Protected Member Functions
virtual void	on_set_scroll_adjustments (Adjustment *hadjustment, Adjustment *vadjustment)
	This is a default handler for the signal signal_set_scroll_adjustments(). More...
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
virtual void	forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
virtual char *	composite_name_vfunc (GtkWidget *child)
virtual void	set_child_property_vfunc (GtkWidget *child, guint property_id, const GValue *value, GParamSpec *pspec)
virtual void	get_child_property_vfunc (GtkWidget *child, guint property_id, GValue *value, GParamSpec *pspec) const
Glib::PropertyProxy< guint >	property_border_width ()
Glib::PropertyProxy_ReadOnly< guint >	property_border_width () const
Glib::PropertyProxy< ResizeMode >	property_resize_mode ()
Glib::PropertyProxy_ReadOnly< ResizeMode >	property_resize_mode () const
Glib::PropertyProxy_WriteOnly< Widget * >	property_child ()
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_request (Requisition *requisition)
	This is a default handler for the signal signal_size_request(). 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_changed (const Glib::RefPtr< Gtk::Style > &previous_style)
	This is a default handler for the signal signal_style_changed(). 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 *event)
	This is a default handler for the signal signal_event(). More...
virtual bool	on_button_press_event (GdkEventButton *event)
	This is a default handler for the signal signal_button_press_event(). More...
virtual bool	on_button_release_event (GdkEventButton *event)
	This is a default handler for the signal signal_button_release_event(). More...
virtual bool	on_scroll_event (GdkEventScroll *event)
	This is a default handler for the signal signal_scroll_event(). More...
virtual bool	on_motion_notify_event (GdkEventMotion *event)
	This is a default handler for the signal signal_motion_notify_event(). More...
virtual bool	on_delete_event (GdkEventAny *event)
	This is a default handler for the signal signal_delete_event(). More...
virtual bool	on_expose_event (GdkEventExpose *event)
	This is a default handler for the signal signal_expose_event(). More...
virtual bool	on_key_press_event (GdkEventKey *event)
	This is a default handler for the signal signal_key_press_event(). More...
virtual bool	on_key_release_event (GdkEventKey *event)
	This is a default handler for the signal signal_key_release_event(). More...
virtual bool	on_enter_notify_event (GdkEventCrossing *event)
	This is a default handler for the signal signal_enter_notify_event(). More...
virtual bool	on_leave_notify_event (GdkEventCrossing *event)
	This is a default handler for the signal signal_leave_notify_event(). More...
virtual bool	on_configure_event (GdkEventConfigure *event)
	This is a default handler for the signal signal_configure_event(). More...
virtual bool	on_focus_in_event (GdkEventFocus *event)
	This is a default handler for the signal signal_focus_in_event(). More...
virtual bool	on_focus_out_event (GdkEventFocus *event)
	This is a default handler for the signal signal_focus_out_event(). More...
virtual bool	on_map_event (GdkEventAny *event)
	This is a default handler for the signal signal_map_event(). More...
virtual bool	on_unmap_event (GdkEventAny *event)
	This is a default handler for the signal signal_unmap_event(). More...
virtual bool	on_property_notify_event (GdkEventProperty *event)
	This is a default handler for the signal signal_property_notify_event(). More...
virtual bool	on_selection_clear_event (GdkEventSelection *event)
	This is a default handler for the signal signal_selection_clear_event(). More...
virtual bool	on_selection_request_event (GdkEventSelection *event)
	This is a default handler for the signal signal_selection_request_event(). More...
virtual bool	on_selection_notify_event (GdkEventSelection *event)
	This is a default handler for the signal signal_selection_notify_event(). More...
virtual bool	on_proximity_in_event (GdkEventProximity *event)
	This is a default handler for the signal signal_proximity_in_event(). More...
virtual bool	on_proximity_out_event (GdkEventProximity *event)
	This is a default handler for the signal signal_proximity_out_event(). More...
virtual bool	on_visibility_notify_event (GdkEventVisibility *event)
	This is a default handler for the signal signal_visibility_notify_event(). More...
virtual bool	on_client_event (GdkEventClient *event)
	This is a default handler for the signal signal_client_event(). More...
virtual bool	on_no_expose_event (GdkEventAny *event)
	This is a default handler for the signal signal_no_expose_event(). More...
virtual bool	on_window_state_event (GdkEventWindowState *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 void	hide_all_vfunc ()
	Widget ()
void	realize ()
void	unrealize ()
void	set_mapped (bool mapped=true)
void	set_realized (bool realized=true)
void	style_attach ()
void	get_child_requisition (Requisition &requisition) const
void	get_style_property_value (const Glib::ustring &the_property_name, Glib::ValueBase &value) const
void	realize_if_needed ()

Related Functions
(Note that these are not member functions.)
Gtk::TreeView *	wrap (GtkTreeView *object, bool take_copy=false)
Related Functions inherited from Gtk::Container
Gtk::Container *	wrap (GtkContainer *object, bool take_copy=false)
Related Functions inherited from Gtk::Widget
Gtk::Widget *	wrap (GtkWidget *object, bool take_copy=false)
Related Functions inherited from Gtk::Object
Gtk::Object *	wrap (GtkObject *object, bool take_copy=false)

Additional Inherited Members
Static Public Member Functions inherited from Gtk::Widget
static Widget *	get_current_modal_grab ()
static void	push_colormap (const Glib::RefPtr< const Gdk::Colormap > &cmap)
static void	pop_colormap ()
static void	push_composite_child ()
static void	pop_composite_child ()
static void	set_default_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
static Glib::RefPtr< Style >	get_default_style ()
static Glib::RefPtr< Gdk::Colormap >	get_default_colormap ()
static Glib::RefPtr< Gdk::Visual >	get_default_visual ()
static void	set_default_direction (TextDirection dir)
static TextDirection	get_default_direction ()
static Widget *	drag_get_source_widget (const Glib::RefPtr< Gdk::DragContext > &context)

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(), insert_column(), or insert_column_editable().

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

Definition at line 182 of file treeview.h.

Member Typedef Documentation

Column

typedef TreeViewColumn Gtk::TreeView::Column

A visible column in a Gtk::TreeView widget.

Definition at line 256 of file treeview.h.

Selection

typedef TreeSelection Gtk::TreeView::Selection

A selection object for Gtk::TreeView.

Definition at line 260 of file treeview.h.

SlotCellData

typedef TreeViewColumn::SlotCellData Gtk::TreeView::SlotCellData

Definition at line 552 of file treeview.h.

SlotColumnDrop

typedef sigc::slot<bool, TreeView*, TreeViewColumn*, TreeViewColumn*, TreeViewColumn*> Gtk::TreeView::SlotColumnDrop

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.

Definition at line 669 of file treeview.h.

SlotMapping

typedef sigc::slot<void, TreeView*, const TreeModel::Path&> Gtk::TreeView::SlotMapping

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

Definition at line 825 of file treeview.h.

SlotRowSeparator

typedef sigc::slot<bool, const Glib::RefPtr<TreeModel>&, const TreeModel::iterator&> Gtk::TreeView::SlotRowSeparator

For instance, void on_row_separator(const Gtk::TreeModel& model, const Gtk::TreeModel::iterator& iter);

Definition at line 1498 of file treeview.h.

SlotSearchEqual

typedef sigc::slot<bool, const Glib::RefPtr<TreeModel>&, int, const Glib::ustring&, const TreeModel::iterator&> Gtk::TreeView::SlotSearchEqual

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

Definition at line 1321 of file treeview.h.

SlotSearchPosition

typedef sigc::slot<void, Gtk::Widget* > Gtk::TreeView::SlotSearchPosition

void on_search_position(Gtk::Widget* search_dialog)

Definition at line 1359 of file treeview.h.

Constructor & Destructor Documentation

~TreeView()

virtual Gtk::TreeView::~TreeView ( )

virtual

TreeView() [1/2]

Gtk::TreeView::TreeView

(

)

Default constructor

TreeView() [2/2]

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

explicit

Constructor that binds to a TreeModel

Member Function Documentation

_get_base_model()

Glib::RefPtr<Gtk::TreeModel> Gtk::TreeView::_get_base_model

(

)

Get the treeview's model, but actually get the child model if it's a TreeModelFilter.

append_column() [1/3]

int Gtk::TreeView::append_column	(	const Glib::ustring &	title,
		CellRenderer &	cell
	)

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

append_column() [2/3]

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

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.

Returns

The number of columns in the View after appending.

Definition at line 2050 of file treeview.h.

append_column() [3/3]

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

column

The Gtk::TreeViewColumn to add.

Returns

The number of columns in tree_view after appending.

append_column_editable()

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

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.

Returns

The number of columns in the View after appending.

Definition at line 2111 of file treeview.h.

append_column_numeric()

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

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.
format	A 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.

Definition at line 2065 of file treeview.h.

append_column_numeric_editable()

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

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.
format	A 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.

Definition at line 2095 of file treeview.h.

collapse_all()

void Gtk::TreeView::collapse_all

(

)

Recursively collapses all visible, expanded nodes in tree_view.

collapse_row()

bool Gtk::TreeView::collapse_row

(

const TreeModel::Path &

path

)

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

Parameters

path	Path to a row in the tree_view.

Returns

true if the row was collapsed.

columns_autosize()

void Gtk::TreeView::columns_autosize

(

)

Resizes all columns to their optimal width. Only works after the treeview has been realized.

convert_bin_window_to_tree_coords()

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).

Parameters

bx	X coordinate relative to bin_window.
by	Y coordinate relative to bin_window.
tx	Return location for tree X coordinate.
ty	Return location for tree Y coordinate.

convert_bin_window_to_widget_coords()

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.

Parameters

bx	Bin_window X coordinate.
by	Bin_window Y coordinate.
wx	Return location for widget X coordinate.
wy	Return location for widget Y coordinate.

convert_tree_to_bin_window_coords()

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.

Parameters

tx	Tree X coordinate.
ty	Tree Y coordinate.
bx	Return location for X coordinate relative to bin_window.
by	Return location for Y coordinate relative to bin_window.

convert_tree_to_widget_coords()

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.

Parameters

tx	X coordinate relative to the tree.
ty	Y coordinate relative to the tree.
wx	Return location for widget X coordinate.
wy	Return location for widget Y coordinate.

convert_widget_to_bin_window_coords()

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()).

Parameters

wx	X coordinate relative to the widget.
wy	Y coordinate relative to the widget.
bx	Return location for bin_window X coordinate.
by	Return location for bin_window Y coordinate.

convert_widget_to_tree_coords()

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).

Parameters

wx	X coordinate relative to the widget.
wy	Y coordinate relative to the widget.
tx	Return location for tree X coordinate.
ty	Return location for tree Y coordinate.

create_row_drag_icon()

Glib::RefPtr<Gdk::Pixmap> Gtk::TreeView::create_row_drag_icon

(

const TreeModel::Path &

path

)

Creates a Gdk::Pixmap representation of the row at path. This image is used for a drag icon.

Parameters

path	A Gtk::TreePath in tree_view.

Returns

A newly-allocated pixmap of the drag icon.

enable_model_drag_dest() [1/2]

void Gtk::TreeView::enable_model_drag_dest	(	const ArrayHandle_TargetEntry &	targets,
		Gdk::DragAction	actions = Gdk::ACTION_COPY|Gdk::ACTION_MOVE
	)

Turns the TreeView into a drop destination for automatic DND.

Parameters

targets	The table of targets that the drag will support.
actions	The bitmask of possible actions for a drag from this widget.

enable_model_drag_dest() [2/2]

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

actions

The bitmask of possible actions for a drag from this widget.

enable_model_drag_source() [1/2]

void Gtk::TreeView::enable_model_drag_source	(	const ArrayHandle_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

targets	Standard container of targets that the drag will support.
start_button_mask	Mask of allowed buttons to start drag.
actions	The bitmask of possible actions for a drag from this widget.

enable_model_drag_source() [2/2]

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_mask	Mask of allowed buttons to start drag.
actions	The bitmask of possible actions for a drag from this widget.

expand_all()

void Gtk::TreeView::expand_all

(

)

Recursively expands all nodes in the tree_view.

expand_row()

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

Opens the row so its children are visible.

Parameters

path	Path to a row.
open_all	Whether to recursively expand, or just expand immediate children.

Returns

true if the row existed and had children.

expand_to_path()

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.

Parameters

path	Path to a row.

get_background_area() [1/2]

void Gtk::TreeView::get_background_area	(	const TreeModel::Path &	path,
		TreeViewColumn &	column,
		Gdk::Rectangle &	rect
	)

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

path	A Gtk::TreePath for the row.
column	A Gtk::TreeViewColumn for the column.
rect	Rectangle to fill with cell background rect.

get_background_area() [2/2]

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

path	A Gtk::TreePath for the row.
column	A Gtk::TreeViewColumn for the column.
rect	Rectangle to fill with cell background rect.

get_bin_window() [1/2]

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 0 when tree_view hasn't been realized yet.

get_bin_window() [2/2]

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 0 when tree_view hasn't been realized yet.

get_cell_area() [1/2]

void Gtk::TreeView::get_cell_area	(	const TreeModel::Path &	path,
		TreeViewColumn &	column,
		Gdk::Rectangle &	rect
	)

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 Gtk::TreeView is realized.

Parameters

path	A Gtk::TreePath for the row.
column	A Gtk::TreeViewColumn for the column.
rect	Rectangle to fill with cell rect.

get_cell_area() [2/2]

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 Gtk::TreeView is realized.

Parameters

path	A Gtk::TreePath for the row.
column	A Gtk::TreeViewColumn for the column.
rect	Rectangle to fill with cell rect.

get_column() [1/2]

TreeViewColumn* Gtk::TreeView::get_column

(

int

n

)

Gets the Gtk::TreeViewColumn at the given position in the Gtk::TreeView

Parameters

n	The position of the column, counting from 0.

Returns

The Gtk::TreeViewColumn, or 0 if the position is outside the range of columns.

get_column() [2/2]

const TreeViewColumn* Gtk::TreeView::get_column

(

int

n

)

const

Gets the Gtk::TreeViewColumn at the given position in the Gtk::TreeView

Parameters

n	The position of the column, counting from 0.

Returns

The Gtk::TreeViewColumn, or 0 if the position is outside the range of columns.

get_column_cell_renderer() [1/2]

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

n	The position of the view column.

Returns

The CellRenderer.

get_column_cell_renderer() [2/2]

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

n	The position of the view column.

Returns

The CellRenderer.

get_columns() [1/2]

Glib::ListHandle<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.

get_columns() [2/2]

Glib::ListHandle<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.

get_cursor()

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

path	A reference to be filled with the current cursor path
focus_column	A reference to be filled with the current focus column

get_dest_row_at_pos()

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_x	The x position to determine the destination row for
drag_y	The y position to determine the destination row for
path	Return location for the path of the highlighted row
pos	Return location for the drop position

get_drag_dest_row()

void Gtk::TreeView::get_drag_dest_row	(	TreeModel::Path &	path,
		TreeViewDropPosition &	pos
	)		const

Gets information about the row that is highlighted for feedback.

Parameters

path	Return location for the path of the highlighted row
pos	Return location for the drop position

get_enable_search()

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.

get_enable_tree_lines()

bool Gtk::TreeView::get_enable_tree_lines

(

)

const

Returns whether or not tree lines are drawn in tree_view.

Returns

true if tree lines are drawn in tree_view, false otherwise.

get_expander_column() [1/2]

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.

get_expander_column() [2/2]

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.

get_fixed_height_mode()

bool Gtk::TreeView::get_fixed_height_mode

(

)

const

Returns whether fixed height mode is turned on for tree_view.

Returns

true if tree_view is in fixed height mode.

get_grid_lines()

TreeViewGridLines Gtk::TreeView::get_grid_lines

(

)

const

Returns which grid lines are enabled in tree_view.

Returns

A Gtk::TreeViewGridLines value indicating which grid lines are enabled.

get_hadjustment() [1/2]

Adjustment* Gtk::TreeView::get_hadjustment

(

)

Gets the Gtk::Adjustment currently being used for the horizontal aspect.

Returns

A Gtk::Adjustment object, or 0 if none is currently being used.

get_hadjustment() [2/2]

const Adjustment* Gtk::TreeView::get_hadjustment

(

)

const

Gets the Gtk::Adjustment currently being used for the horizontal aspect.

Returns

A Gtk::Adjustment object, or 0 if none is currently being used.

get_headers_clickable()

bool Gtk::TreeView::get_headers_clickable

(

)

const

Returns whether all header columns are clickable.

Returns

true if all header columns are clickable, otherwise false.

get_headers_visible()

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.

get_hover_expand()

bool Gtk::TreeView::get_hover_expand

(

)

const

Returns whether hover expansion mode is turned on for tree_view.

Returns

true if tree_view is in hover expansion mode.

get_hover_selection()

bool Gtk::TreeView::get_hover_selection

(

)

const

Returns whether hover selection mode is turned on for tree_view.

Returns

true if tree_view is in hover selection mode.

get_level_indentation()

int Gtk::TreeView::get_level_indentation

(

)

const

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

Returns

The amount of extra indentation for child levels in tree_view. A return value of 0 means that this feature is disabled.

get_model() [1/2]

Glib::RefPtr<TreeModel> Gtk::TreeView::get_model

(

)

Returns the model the Gtk::TreeView is based on. Returns 0 if the model is unset.

Returns

A Gtk::TreeModel, or 0 if none is currently being used.

get_model() [2/2]

Glib::RefPtr<const TreeModel> Gtk::TreeView::get_model

(

)

const

Returns the model the Gtk::TreeView is based on. Returns 0 if the model is unset.

Returns

A Gtk::TreeModel, or 0 if none is currently being used.

get_path_at_pos() [1/3]

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 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

x	The x position to be identified (relative to bin_window).
y	The y position to be identified (relative to bin_window).
path	A reference to a TreeModel::Path to be filled in

Returns

true if a row exists at that coordinate.

get_path_at_pos() [2/3]

bool Gtk::TreeView::get_path_at_pos	(	int	x,
		int	y,
		TreeModel::Path &	path,
		TreeViewColumn *&	column,
		int &	cell_x,
		int &	cell_y
	)

get_path_at_pos() [3/3]

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 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 == gtk_tree_view_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

x	The x position to be identified (relative to bin_window).
y	The y position to be identified (relative to bin_window).
path	A reference to a TreeModel::Path to be filled in
column	A reference to a TreeViewColumn pointer to be filled in
cell_x	A reference where the X coordinate relative to the cell can be placed
cell_y	A reference where the Y coordinate relative to the cell can be placed

Returns

true if a row exists at that coordinate.

get_reorderable()

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.

get_rubber_banding()

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.

Returns

true if rubber banding in tree_view is enabled.

get_rules_hint()

bool Gtk::TreeView::get_rules_hint

(

)

const

Gets the setting set by set_rules_hint().

Returns

true if rules are useful for the user of this tree.

get_search_column()

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.

get_search_entry() [1/2]

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, 0 will be returned.

Returns

The entry currently in use as search entry.

get_search_entry() [2/2]

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, 0 will be returned.

Returns

The entry currently in use as search entry.

get_selection() [1/2]

Glib::RefPtr<TreeSelection> Gtk::TreeView::get_selection

(

)

Gets the Gtk::TreeSelection associated with tree_view.

Returns

A Gtk::TreeSelection object.

get_selection() [2/2]

Glib::RefPtr<const TreeSelection> Gtk::TreeView::get_selection

(

)

const

Gets the Gtk::TreeSelection associated with tree_view.

Returns

A Gtk::TreeSelection object.

get_show_expanders()

bool Gtk::TreeView::get_show_expanders

(

)

const

Returns whether or not expanders are drawn in tree_view.

Returns

true if expanders are drawn in tree_view, false otherwise.

get_tooltip_column()

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.

Returns

The index of the tooltip column that is currently being used, or -1 if this is disabled.

get_tooltip_context_iter()

bool Gtk::TreeView::get_tooltip_context_iter	(	int &	x,
		int &	y,
		bool	keyboard_tip,
		Gtk::TreeModel::iterator &	iter
	)

Parameters

x	the x coordinate (relative to widget coordinates)
y	the y coordinate (relative to widget coordinates)
keyboard_tip	whether this is a keyboard tooltip or not
iter	a 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.

get_tooltip_context_path()

bool Gtk::TreeView::get_tooltip_context_path	(	int &	x,
		int &	y,
		bool	keyboard_tip,
		TreeModel::Path &	path
	)

Parameters

x	the x coordinate (relative to widget coordinates)
y	the y coordinate (relative to widget coordinates)
keyboard_tip	whether this is a keyboard tooltip or not
path	a 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.

get_vadjustment() [1/2]

Adjustment* Gtk::TreeView::get_vadjustment

(

)

Gets the Gtk::Adjustment currently being used for the vertical aspect.

Returns

A Gtk::Adjustment object, or 0 if none is currently being used.

get_vadjustment() [2/2]

const Adjustment* Gtk::TreeView::get_vadjustment

(

)

const

Gets the Gtk::Adjustment currently being used for the vertical aspect.

Returns

A Gtk::Adjustment object, or 0 if none is currently being used.

get_visible_range()

bool Gtk::TreeView::get_visible_range	(	TreeModel::Path &	start_path,
		TreeModel::Path &	end_path
	)		const

get_visible_rect() [1/2]

void Gtk::TreeView::get_visible_rect

(

Gdk::Rectangle &

visible_rect

)

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_rect

Rectangle to fill.

get_visible_rect() [2/2]

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_rect

Rectangle to fill.

gobj() [1/2]

GtkTreeView* Gtk::TreeView::gobj ( )

inline

Provides access to the underlying C GtkObject.

Definition at line 219 of file treeview.h.

gobj() [2/2]

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

inline

Provides access to the underlying C GtkObject.

Definition at line 222 of file treeview.h.

insert_column() [1/3]

int Gtk::TreeView::insert_column	(	const Glib::ustring &	title,
		CellRenderer &	cell,
		int	position
	)

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

Parameters

title	The text to be used in the title header of this column.
cell	The CellRenderer.
position	The position at which the CellRenderer should be inserted.

Returns

The number of columns in the View after inserting.

insert_column() [2/3]

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

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.
position	The position at which the CellRenderer should be inserted.

Returns

The number of columns in the View after inserting.

Definition at line 2127 of file treeview.h.

insert_column() [3/3]

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

column	The Gtk::TreeViewColumn to be inserted.
position	The position to insert column in.

Returns

The number of columns in tree_view after insertion.

insert_column_editable()

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 append_column() and connect a signal handler to the CellRenderer.

Parameters

title	The text to be used in the title header of this column.
model_column	The column in the TreeModel that will be rendered by this View column.
position	The position at which the CellRenderer should be inserted.

Returns

The number of columns in the View after inserting.

Definition at line 2137 of file treeview.h.

insert_column_with_data_func()

int Gtk::TreeView::insert_column_with_data_func	(	int	position,
		const Glib::ustring &	title,
		CellRenderer &	cell,
		const SlotCellData &	slot
	)

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

Parameters

position	Position to insert, -1 for append
title	column title
cell	cell renderer for column
slot	function to set attributes of cell renderer

Returns

number of columns in the TreeView after the insert

is_rubber_banding_active()

bool Gtk::TreeView::is_rubber_banding_active

(

)

const

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

Returns

true if a rubber banding operation is currently being done in tree_view.

map_expanded_rows()

void Gtk::TreeView::map_expanded_rows

(

const SlotMapping &

slot

)

Calls the callback slot on all expanded rows.

Parameters

slot	A callback function to be called.

move_column_after()

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

column	The Gtk::TreeViewColumn to be moved.
base_column	The Gtk::TreeViewColumn to be moved relative to.

move_column_to_start()

void Gtk::TreeView::move_column_to_start

(

TreeViewColumn &

column

)

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

Parameters

column

The view column that will be moved

on_columns_changed()

virtual void Gtk::TreeView::on_columns_changed ( )

protectedvirtual

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

on_cursor_changed()

virtual void Gtk::TreeView::on_cursor_changed ( )

protectedvirtual

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

on_row_activated()

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().

on_row_collapsed()

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().

on_row_expanded()

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().

on_set_scroll_adjustments()

virtual void Gtk::TreeView::on_set_scroll_adjustments ( Adjustment *  hadjustment, Adjustment *  vadjustment  )

protectedvirtual

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

on_test_collapse_row()

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().

on_test_expand_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().

property_enable_grid_lines() [1/2]

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.

property_enable_grid_lines() [2/2]

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.

property_enable_search() [1/2]

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.

property_enable_search() [2/2]

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.

property_enable_tree_lines() [1/2]

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.

property_enable_tree_lines() [2/2]

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.

property_expander_column() [1/2]

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.

property_expander_column() [2/2]

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.

property_fixed_height_mode() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_fixed_height_mode

(

)

Speeds up GtkTreeView by assuming that all rows have the same height.

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.

property_fixed_height_mode() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_fixed_height_mode

(

)

const

Speeds up GtkTreeView by assuming that all rows have the same height.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_hadjustment() [1/2]

Glib::PropertyProxy< Adjustment* > Gtk::TreeView::property_hadjustment

(

)

Horizontal Adjustment for the widget.

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.

property_hadjustment() [2/2]

Glib::PropertyProxy_ReadOnly< Adjustment* > Gtk::TreeView::property_hadjustment

(

)

const

Horizontal Adjustment for the widget.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_headers_clickable() [1/2]

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.

property_headers_clickable() [2/2]

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.

property_headers_visible() [1/2]

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.

property_headers_visible() [2/2]

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.

property_hover_expand() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_hover_expand

(

)

Whether rows should be expanded/collapsed when the pointer moves over them.

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.

property_hover_expand() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_hover_expand

(

)

const

Whether rows should be expanded/collapsed when the pointer moves over them.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_hover_selection() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_hover_selection

(

)

Whether the selection should follow the 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.

property_hover_selection() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_hover_selection

(

)

const

Whether the selection should follow the 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.

property_level_indentation() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_level_indentation

(

)

Extra indentation for each level.

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.

property_level_indentation() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_level_indentation

(

)

const

Extra indentation for each level.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_model() [1/2]

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.

property_model() [2/2]

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.

property_reorderable() [1/2]

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.

property_reorderable() [2/2]

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.

property_rubber_banding() [1/2]

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.

property_rubber_banding() [2/2]

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.

property_rules_hint() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_rules_hint

(

)

Set a hint to the theme engine to draw rows in alternating colors.

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.

property_rules_hint() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_rules_hint

(

)

const

Set a hint to the theme engine to draw rows in alternating colors.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_search_column() [1/2]

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.

property_search_column() [2/2]

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.

property_show_expanders() [1/2]

Glib::PropertyProxy< bool > Gtk::TreeView::property_show_expanders

(

)

View has expanders.

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.

property_show_expanders() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::TreeView::property_show_expanders

(

)

const

View has expanders.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_tooltip_column() [1/2]

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.

property_tooltip_column() [2/2]

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.

property_vadjustment() [1/2]

Glib::PropertyProxy< Adjustment* > Gtk::TreeView::property_vadjustment

(

)

Vertical Adjustment for the widget.

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.

property_vadjustment() [2/2]

Glib::PropertyProxy_ReadOnly< Adjustment* > Gtk::TreeView::property_vadjustment

(

)

const

Vertical Adjustment for the widget.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

remove_all_columns()

void Gtk::TreeView::remove_all_columns

(

)

Removes all View columns.

remove_column()

int Gtk::TreeView::remove_column

(

TreeViewColumn &

column

)

Removes column from tree_view.

Parameters

column

The Gtk::TreeViewColumn to remove.

Returns

The number of columns in tree_view after removing.

reset_expander_column()

void Gtk::TreeView::reset_expander_column

(

)

This method resets the expander arrow to the default - the first visible column.

See also

set_expander_column().

row_activated()

void Gtk::TreeView::row_activated	(	const TreeModel::Path &	path,
		TreeViewColumn &	column
	)

Activates the cell determined by path and column.

Parameters

path	The Gtk::TreePath to be activated.
column	The Gtk::TreeViewColumn to be activated.

row_expanded()

bool Gtk::TreeView::row_expanded

(

const TreeModel::Path &

path

)

Returns true if the node pointed to by path is expanded in tree_view.

Parameters

path	A Gtk::TreePath to test expansion state.

Returns

true if path is expanded.

scroll_to_cell() [1/2]

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

path	The path of the row to move to.
column	The Gtk::TreeViewColumn to move horizontally to.

scroll_to_cell() [2/2]

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

path	The path of the row to move to.
column	The Gtk::TreeViewColumn to move horizontally to.
row_align	The vertical alignment of the row specified by path.
col_align	The horizontal alignment of the column specified by column.

scroll_to_column() [1/2]

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

column

The Gtk::TreeViewColumn to move horizontally to.

scroll_to_column() [2/2]

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

column	The Gtk::TreeViewColumn to move horizontally to.
col_align	The horizontal alignment of the column specified by column.

scroll_to_point()

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_x	X coordinate of new top-left pixel of visible area, or -1.
tree_y	Y coordinate of new top-left pixel of visible area, or -1.

scroll_to_row() [1/2]

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

path	The path of the row to move to.

scroll_to_row() [2/2]

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

path	The path of the row to move to.
row_align	The vertical alignment of the row specified by path.

set_column_drag_function()

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

slot	A callback function to determine which columns are reorderable.

set_cursor() [1/3]

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

path	A reference to cursor path.

set_cursor() [2/3]

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

path	A Gtk::TreePath.
focus_column	A Gtk::TreeViewColumn.
start_editing	true if the specified cell should start being edited.

set_cursor() [3/3]

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 0, then focus is given to the column specified by it. If focus_column and focus_cell are not 0, 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.

Parameters

path	A Gtk::TreePath.
focus_column	A Gtk::TreeViewColumn, or 0.
focus_cell	A Gtk::CellRenderer, or 0.
start_editing	true if the specified cell should start being edited.

set_drag_dest_row()

void Gtk::TreeView::set_drag_dest_row	(	const TreeModel::Path &	path,
		TreeViewDropPosition	pos
	)

Sets the row that is highlighted for feedback.

Parameters

path	The path of the row to highlight
pos	Specifies whether to drop before, after or into the row

set_enable_search()

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_search

true, if the user can search interactively.

set_enable_tree_lines()

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.

Parameters

enable

true to enable tree line drawing, false otherwise.

set_expander_column()

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

column

The column to draw the expander arrow at.

set_fixed_height_mode()

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.

Parameters

enable

true to enable fixed height mode.

set_grid_lines()

void Gtk::TreeView::set_grid_lines

(

TreeViewGridLines

grid_lines

)

Sets which grid lines to draw in tree_view.

Parameters

grid_lines

A Gtk::TreeViewGridLines value indicating which grid lines to enable.

set_hadjustment()

void Gtk::TreeView::set_hadjustment

(

Adjustment &

adjustment

)

Sets the Gtk::Adjustment for the current horizontal aspect. See also unset_hadjustment().

Parameters

adjustment

The Gtk::Adjustment to set.

set_headers_clickable()

void Gtk::TreeView::set_headers_clickable

(

bool

setting = true

)

Allow the column title buttons to be clicked.

Parameters

setting

true if the columns are clickable.

set_headers_visible()

void Gtk::TreeView::set_headers_visible

(

bool

headers_visible = true

)

Sets the visibility state of the headers.

Parameters

headers_visible

true if the headers are visible.

set_hover_expand()

void Gtk::TreeView::set_hover_expand

(

bool

expand = true

)

Enables of disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

Parameters

expand

true to enable hover selection mode.

set_hover_selection()

void Gtk::TreeView::set_hover_selection

(

bool

hover = true

)

Enables of 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.

Parameters

hover

true to enable hover selection mode.

set_level_indentation()

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.

Parameters

indentation

The amount, in pixels, of extra indentation in tree_view.

set_model()

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

model

The model.

set_reorderable()

void Gtk::TreeView::set_reorderable

(

bool

reorderable = true

)

This function is a convenience function to allow you to reorder models that support the Gtk::DragSourceIface and the Gtk::DragDestIface. Both Gtk::TreeStore and Gtk::ListStore support these. If reorderable is true, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's row_inserted and row_deleted signals. The reordering is implemented by setting up the 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

reorderable

true, if the tree can be reordered.

set_row_separator_func()

void Gtk::TreeView::set_row_separator_func

(

const SlotRowSeparator &

slot

)

set_rubber_banding()

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.

Parameters

enable

true to enable rubber banding.

set_rules_hint()

void Gtk::TreeView::set_rules_hint

(

bool

setting = true

)

This function tells GTK+ that the user interface for your application requires users to read across tree rows and associate cells with one another. By default, GTK+ will then render the tree with alternating row colors. 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).

Parameters

setting

true if the tree requires reading across rows.

set_search_column() [1/2]

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

column

The column of the model to search in, or -1 to disable searching.

set_search_column() [2/2]

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

column

The column of the model to search in, or -1 to disable searching.

set_search_entry()

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 0 for entry will make the interactive search code use the built-in popup entry again.

Parameters

entry

The entry the interactive search code of tree_view should use or 0.

set_search_equal_func()

void Gtk::TreeView::set_search_equal_func

(

const SlotSearchEqual &

slot

)

Sets the compare function for the interactive search capabilities.

Parameters

slot	The compare function to use during the search

set_search_position_func()

void Gtk::TreeView::set_search_position_func

(

const SlotSearchPosition &

slot

)

set_show_expanders()

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.

Parameters

enabled

true to enable expander drawing, false otherwise.

set_tooltip_cell()

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 0 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.

Parameters

tooltip	A Gtk::Tooltip.
path	A Gtk::TreePath or 0.
column	A Gtk::TreeViewColumn or 0.
cell	A Gtk::CellRenderer or 0.

set_tooltip_column()

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::signal_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.

Parameters

column

An integer, which is a valid column number for tree_view's model.

set_tooltip_row()

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 Tooltip::set_tip_area().

Parameters

tooltip	A Gtk::Tooltip.
path	A Gtk::TreePath.

set_vadjustment()

void Gtk::TreeView::set_vadjustment

(

Adjustment &

adjustment

)

Sets the Gtk::Adjustment for the current vertical aspect. See also unset_vadjustment().

Parameters

adjustment

The Gtk::Adjustment to set.

signal_columns_changed()

Glib::SignalProxy0< void > Gtk::TreeView::signal_columns_changed

(

)

Slot Prototype:

void on_my_columns_changed()

signal_cursor_changed()

Glib::SignalProxy0< void > Gtk::TreeView::signal_cursor_changed

(

)

Slot Prototype:

void on_my_cursor_changed()

signal_row_activated()

Glib::SignalProxy2< void,const TreeModel::Path&,TreeViewColumn* > Gtk::TreeView::signal_row_activated

(

)

Slot Prototype:

void on_my_row_activated(const TreeModel::Path& path, TreeViewColumn* column)

signal_row_collapsed()

Glib::SignalProxy2< 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)

signal_row_expanded()

Glib::SignalProxy2< 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)

signal_set_scroll_adjustments()

Glib::SignalProxy2< void,Adjustment*,Adjustment* > Gtk::TreeView::signal_set_scroll_adjustments

(

)

Slot Prototype:

void on_my_set_scroll_adjustments(Adjustment* hadjustment, Adjustment* vadjustment)

signal_test_collapse_row()

Glib::SignalProxy2< 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)

signal_test_expand_row()

Glib::SignalProxy2< 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)

tree_to_widget_coords() [1/2]

void Gtk::TreeView::tree_to_widget_coords	(	int	tx,
		int	ty,
		int &	wx,
		int &	wy
	)

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

Deprecated: 2.12: Due to historial reasons the name of this function is incorrect. For converting bin_window coordinates to coordinates relative to bin_window, please see convert_bin_window_to_widget_coords().

Parameters

tx	Tree X coordinate.
ty	Tree Y coordinate.
wx	Return location for X coordinate relative to bin_window.
wy	Return location for Y coordinate relative to bin_window.

tree_to_widget_coords() [2/2]

void Gtk::TreeView::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 bin_window coordinates.

Deprecated: 2.12: Due to historial reasons the name of this function is incorrect. For converting bin_window coordinates to coordinates relative to bin_window, please see convert_bin_window_to_widget_coords().

Parameters

tx	Tree X coordinate.
ty	Tree Y coordinate.
wx	Return location for X coordinate relative to bin_window.
wy	Return location for Y coordinate relative to bin_window.

unset_column_drag_function()

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.

unset_hadjustment()

void Gtk::TreeView::unset_hadjustment

(

)

This method removes the hadjustment.

See also

set_hadjustment().

unset_model()

void Gtk::TreeView::unset_model

(

)

Remove the model from the TreeView.

See also

set_model().

unset_rows_drag_dest()

void Gtk::TreeView::unset_rows_drag_dest

(

)

Undoes the effect of enable_model_drag_source()

unset_rows_drag_source()

void Gtk::TreeView::unset_rows_drag_source

(

)

Undoes the effect of enable_model_drag_source()

unset_vadjustment()

void Gtk::TreeView::unset_vadjustment

(

)

This method removes the vadjustment.

See also

set_vadjustment().

widget_to_tree_coords() [1/2]

void Gtk::TreeView::widget_to_tree_coords	(	int	wx,
		int	wy,
		int &	tx,
		int &	ty
	)

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

Deprecated: 2.12: Due to historial reasons the name of this function is incorrect. For converting coordinates relative to the widget to bin_window coordinates, please see convert_widget_to_bin_window_coords().

Parameters

wx	X coordinate relative to bin_window.
wy	Y coordinate relative to bin_window.
tx	Return location for tree X coordinate.
ty	Return location for tree Y coordinate.

widget_to_tree_coords() [2/2]

void Gtk::TreeView::widget_to_tree_coords	(	int	wx,
		int	wy,
		int &	tx,
		int &	ty
	)		const

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

Deprecated: 2.12: Due to historial reasons the name of this function is incorrect. For converting coordinates relative to the widget to bin_window coordinates, please see convert_widget_to_bin_window_coords().

Parameters

wx	X coordinate relative to bin_window.
wy	Y coordinate relative to bin_window.
tx	Return location for tree X coordinate.
ty	Return location for tree Y coordinate.

Friends And Related Function Documentation

wrap()

Gtk::TreeView * wrap ( GtkTreeView *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.

---

The documentation for this class was generated from the following file:

• treeview.h