#include <gtkmm/treemodelfilter.h>

Inheritance diagram for Gtk::TreeModelFilter:

Public Types
typedef sigc::slot< bool, const TreeModel::const_iterator & >	SlotVisible
	For instance, bool on_visible(const TreeModel::const_iterator& iter); This should return true if the given row should be visible and false otherwise. More...

typedef sigc::slot< void, const Gtk::TreeModel::iterator &, Glib::ValueBase &, int >	SlotModify
	For instance, void on_modify(const Gtk::TreeModel::iterator& iter, Glib::ValueBase& value, int column);. More...

Public Types inherited from Gtk::TreeModel
typedef TreeModelColumnRecord	ColumnRecord

typedef TreeNodeChildren	Children

typedef Children::iterator	iterator

typedef Children::const_iterator	const_iterator

typedef Children::reverse_iterator	reverse_iterator

typedef Children::const_reverse_iterator	const_reverse_iterator

typedef TreeRow	Row

typedef TreePath	Path

typedef TreeRowReference	RowReference

typedef sigc::slot< bool, const TreeModel::iterator & >	SlotForeachIter
	The type of callback slot used by foreach_iter(). More...

typedef sigc::slot< bool, const TreeModel::Path & >	SlotForeachPath
	The type of callback slot used by foreach_path(). More...

typedef sigc::slot< bool, const TreeModel::Path &, const TreeModel::iterator & >	SlotForeachPathAndIter
	The type of callback slot used by foreach(). More...

Public Member Functions
	TreeModelFilter (TreeModelFilter && src) noexcept

TreeModelFilter &	operator= (TreeModelFilter && src) noexcept

	~TreeModelFilter () noexcept override

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

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

GtkTreeModelFilter *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

void	set_visible_func (const SlotVisible & slot)
	Sets the "visible" callback used when filtering the filter. More...

void	set_modify_func (const TreeModelColumnRecord & columns, const SlotModify & slot)
	Specify columns that will be provided by this model, and a callback that will provide data for these columns based on data in the columns of the child model. More...

void	set_visible_column (const TreeModelColumnBase & column)
	Sets column of the child_model to be the column where filter should look for visibility information. More...

void	set_visible_column (int column)
	Sets column of the child_model to be the column where filter should look for visibility information. More...

Glib::RefPtr< TreeModel >	get_model ()
	Returns a pointer to the child model of filter. More...

Glib::RefPtr< const TreeModel >	get_model () const
	Returns a pointer to the child model of filter. More...

iterator	convert_child_iter_to_iter (const iterator & child_iter) const
	Gets an iterator that points to the sorted row that corresponds to the child row pointed at by child_iter. More...

iterator	convert_iter_to_child_iter (const iterator & filter_iter) const
	Gets an iterator that points to the child row that corresponds to the sorted row pointed at by sorted_iter. More...

Path	convert_child_path_to_path (const Path & child_path) const
	Converts child_path to a path relative to filter. More...

Path	convert_path_to_child_path (const Path & filter_path) const
	Converts filter_path to a path on the child model of filter. More...

void	refilter ()
	Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. More...

void	clear_cache ()
	This function should almost never be called. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > >	property_child_model () const
	The model for the filtermodel to filter. More...

Glib::PropertyProxy_ReadOnly< TreeModel::Path >	property_virtual_root () const
	The virtual root (relative to the child model) for this filtermodel. More...

Public Member Functions inherited from Gtk::TreeModel
	TreeModel (TreeModel && src) noexcept

TreeModel &	operator= (TreeModel && src) noexcept

	~TreeModel () noexcept override

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

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

iterator	get_iter (const Path & path)
	Returns a valid iterator pointing to path. More...

iterator	get_iter (const Glib::ustring & path_string)
	Returns a valid iterator pointing to path_string. More...

Children	children ()
	This returns an STL-like container API, for iterating over the rows. More...

Children	children () const
	This returns an STL-like container API, for iterating over the rows. More...

void	foreach_iter (const SlotForeachIter & slot)
	Calls a callback of type SlotForeachIter on each node in the model in a depth-first fashion. More...

void	foreach_path (const SlotForeachPath & slot)
	Calls a callback of type SlotForeachPath on each node in the model in a depth-first fashion. More...

void	foreach (const SlotForeachPathAndIter & slot)
	Calls a callback of type SlotForeachPathAndIter on each node in the model in a depth-first fashion. More...

TreeModelFlags	get_flags () const
	Returns a set of flags supported by this interface. More...

int	get_n_columns () const
	Returns the number of columns supported by tree_model. More...

GType	get_column_type (int index) const
	Returns the type of the column. More...

TreeModel::Path	get_path (const iterator & iter) const
	Returns a Gtk::TreePath referenced by iter. More...

void	row_changed (const Path & path, const iterator & iter)
	Emits the Gtk::TreeModel::signal_row_changed() signal on tree_model. More...

void	row_inserted (const Path & path, const iterator & iter)
	Emits the Gtk::TreeModel::signal_row_inserted() signal on tree_model. More...

void	row_has_child_toggled (const Path & path, const iterator & iter)
	Emits the Gtk::TreeModel::signal_row_has_child_toggled() signal on tree_model. More...

void	row_deleted (const Path & path)
	Emits the Gtk::TreeModel::signal_row_deleted() signal on tree_model. More...

void	rows_reordered (const Path & path, const iterator & iter, const std::vector< int > & new_order)
	Emits the "rows_reordered" signal on the tree model. More...

void	rows_reordered (const Path & path, const std::vector< int > & new_order)
	Emits the "rows_reordered" signal on the tree model. More...

void	rows_reordered (const Path & path, const iterator & iter, int * new_order)
	Emits the Gtk::TreeModel::signal_rows_reordered() signal on tree_model. More...

Glib::ustring	get_string (const iterator & iter) const
	Generates a string representation of the iter. More...

Glib::SignalProxy< void, const TreeModel::Path &, const TreeModel::iterator & >	signal_row_changed ()

Glib::SignalProxy< void, const TreeModel::Path &, const TreeModel::iterator & >	signal_row_inserted ()

Glib::SignalProxy< void, const TreeModel::Path &, const TreeModel::iterator & >	signal_row_has_child_toggled ()

Glib::SignalProxy< void, const TreeModel::Path & >	signal_row_deleted ()

Glib::SignalProxy< void, const TreeModel::Path &, const TreeModel::iterator &, int * >	signal_rows_reordered ()

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

static Glib::RefPtr< TreeModelFilter >	create (const Glib::RefPtr< TreeModel > & child_model)
	This creates a TreeModelFilter with child_model as the child model. More...

static Glib::RefPtr< TreeModelFilter >	create (const Glib::RefPtr< TreeModel > & child_model, const TreeModel::Path & virtual_root)
	This creates a TreeModelFilter with child_model as the child model, and root as the virtual root. More...

Static Public Member Functions inherited from Gtk::TreeModel
static void	add_interface (GType gtype_implementer)

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

Protected Member Functions
	TreeModelFilter (const Glib::RefPtr< TreeModel > & child_model)

	TreeModelFilter (const Glib::RefPtr< TreeModel > & child_model, const TreeModel::Path & virtual_root)

void	set_value_impl (const iterator & row, int column, const Glib::ValueBase & value) override
	Override and implement this in a derived TreeModel class, so that Row::operator() and Row::set_value() work. More...

Protected Member Functions inherited from Gtk::TreeModel
	TreeModel ()
	You should derive from this class to use it. More...

virtual TreeModelFlags	get_flags_vfunc () const

virtual int	get_n_columns_vfunc () const

virtual GType	get_column_type_vfunc (int index) const

virtual bool	iter_next_vfunc (const iterator & iter, iterator & iter_next) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	get_iter_vfunc (const Path & path, iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	iter_children_vfunc (const iterator & parent, iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	iter_parent_vfunc (const iterator & child, iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	iter_nth_child_vfunc (const iterator & parent, int n, iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	iter_nth_root_child_vfunc (int n, iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual bool	iter_has_child_vfunc (const iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual int	iter_n_children_vfunc (const iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual int	iter_n_root_children_vfunc () const
	Override and implement this in a derived TreeModel class. More...

virtual void	ref_node_vfunc (const iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual void	unref_node_vfunc (const iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual TreeModel::Path	get_path_vfunc (const iterator & iter) const
	Override and implement this in a derived TreeModel class. More...

virtual void	get_value_vfunc (const iterator & iter, int column, Glib::ValueBase & value) const
	Override and implement this in a derived TreeModel class. More...

virtual void	set_value_impl (const iterator & row, int column, const Glib::ValueBase & value)
	Override and implement this in a derived TreeModel class, so that Row::operator() and Row::set_value() work. More...

virtual void	get_value_impl (const iterator & row, int column, Glib::ValueBase & value) const

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

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

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

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

virtual void	on_rows_reordered (const TreeModel::Path & path, const TreeModel::iterator & iter, int * new_order)
	This is a default handler for the signal signal_rows_reordered(). More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::TreeModelFilter >	wrap (GtkTreeModelFilter * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::TreeModel
Glib::RefPtr< Gtk::TreeModel >	wrap (GtkTreeModel * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Member Typedef Documentation

◆ SlotModify

typedef sigc::slot<void, const Gtk::TreeModel::iterator& , Glib::ValueBase& , int > Gtk::TreeModelFilter::SlotModify

For instance, void on_modify(const Gtk::TreeModel::iterator& iter, Glib::ValueBase& value, int column);.

where iter is an iterator to a row in the child model, value is an output parameter in which you must store the value to be used in the parent model's row, column is the column in the parent row whose row value you must provide in the value output paramater.

◆ SlotVisible

typedef sigc::slot<bool, const TreeModel::const_iterator&> Gtk::TreeModelFilter::SlotVisible

For instance, bool on_visible(const TreeModel::const_iterator& iter); This should return true if the given row should be visible and false otherwise.

Constructor & Destructor Documentation

◆ TreeModelFilter() [1/3]

Gtk::TreeModelFilter::TreeModelFilter ( TreeModelFilter && src )

noexcept

◆ ~TreeModelFilter()

Gtk::TreeModelFilter::~TreeModelFilter ( )

overridenoexcept

◆ TreeModelFilter() [2/3]

Gtk::TreeModelFilter::TreeModelFilter ( const Glib::RefPtr< TreeModel > & child_model )

explicitprotected

◆ TreeModelFilter() [3/3]

Gtk::TreeModelFilter::TreeModelFilter	(	const Glib::RefPtr< TreeModel > &	child_model,
		const TreeModel::Path &	virtual_root
	)

explicitprotected

Member Function Documentation

◆ clear_cache()

void Gtk::TreeModelFilter::clear_cache ( )

This function should almost never be called.

It clears the filter of any cached iterators that haven’t been reffed with ref_node(). This might be useful if the child model being filtered is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid.

Since gtkmm 2.4:

◆ convert_child_iter_to_iter()

iterator Gtk::TreeModelFilter::convert_child_iter_to_iter ( const iterator & child_iter ) const

Gets an iterator that points to the sorted row that corresponds to the child row pointed at by child_iter.

Parameters

child_iter A valid iterator pointing to a row on the child model.

Returns: A valid iterator that points to the row in this sorted model.

◆ convert_child_path_to_path()

Path Gtk::TreeModelFilter::convert_child_path_to_path ( const Path & child_path ) const

Converts child_path to a path relative to filter.

That is, child_path points to a path in the child model. The rerturned path will point to the same row in the filtered model. If child_path isn’t a valid path on the child model or points to a row which is not visible in filter, then nullptr is returned.

Since gtkmm 2.4:

Parameters

child_path A Gtk::TreePath to convert.

Returns: A newly allocated Gtk::TreePath, or nullptr.

◆ convert_iter_to_child_iter()

iterator Gtk::TreeModelFilter::convert_iter_to_child_iter ( const iterator & filter_iter ) const

Gets an iterator that points to the child row that corresponds to the sorted row pointed at by sorted_iter.

Parameters

filter_iter A valid iterator pointing to a row on the sorted model.

Returns: A valid iterator that points to the row in the child model.

◆ convert_path_to_child_path()

Path Gtk::TreeModelFilter::convert_path_to_child_path ( const Path & filter_path ) const

Converts filter_path to a path on the child model of filter.

That is, filter_path points to a location in filter. The returned path will point to the same location in the model not being filtered. If filter_path does not point to a location in the child model, nullptr is returned.

Since gtkmm 2.4:

Parameters

filter_path A Gtk::TreePath to convert.

Returns: A newly allocated Gtk::TreePath, or nullptr.

◆ create() [1/2]

static Glib::RefPtr< TreeModelFilter > Gtk::TreeModelFilter::create ( const Glib::RefPtr< TreeModel > & child_model )

static

This creates a TreeModelFilter with child_model as the child model.

You can use set_visible_func(), set_visible_column() and/or set_modify_func() to change the mapping of child model to parent model.

◆ create() [2/2]

static Glib::RefPtr< TreeModelFilter > Gtk::TreeModelFilter::create	(	const Glib::RefPtr< TreeModel > &	child_model,
		const TreeModel::Path &	virtual_root
	)

static

This creates a TreeModelFilter with child_model as the child model, and root as the virtual root.

You can use set_visible_func(), set_visible_column() and/or set_modify_func() to change the mapping of child model to parent model.

◆ get_model() [1/2]

Glib::RefPtr< TreeModel > Gtk::TreeModelFilter::get_model ( )

Returns a pointer to the child model of filter.

Since gtkmm 2.4:

Returns: A pointer to a Gtk::TreeModel.

◆ get_model() [2/2]

Glib::RefPtr< const TreeModel > Gtk::TreeModelFilter::get_model ( ) const

Returns a pointer to the child model of filter.

Since gtkmm 2.4:

Returns: A pointer to a Gtk::TreeModel.

◆ get_type()

static GType Gtk::TreeModelFilter::get_type ( )

static

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

◆ gobj() [1/2]

GtkTreeModelFilter * Gtk::TreeModelFilter::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkTreeModelFilter * Gtk::TreeModelFilter::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkTreeModelFilter * Gtk::TreeModelFilter::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

TreeModelFilter & Gtk::TreeModelFilter::operator= ( TreeModelFilter && src )

noexcept

◆ property_child_model()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< TreeModel > > Gtk::TreeModelFilter::property_child_model ( ) const

The model for the filtermodel to filter.

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

Glib::PropertyProxy_ReadOnly< TreeModel::Path > Gtk::TreeModelFilter::property_virtual_root ( ) const

The virtual root (relative to the child model) for this filtermodel.

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

◆ refilter()

void Gtk::TreeModelFilter::refilter ( )

Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.

Since gtkmm 2.4:

◆ set_modify_func()

void Gtk::TreeModelFilter::set_modify_func	(	const TreeModelColumnRecord &	columns,
		const SlotModify &	slot
	)

Specify columns that will be provided by this model, and a callback that will provide data for these columns based on data in the columns of the child model.

The modify function will get called for each data access.

Parameters

columns	Column types for this model (which will be exposed to the parent model/view).
slot	A callback which will be called for each data access.

◆ set_value_impl()

void Gtk::TreeModelFilter::set_value_impl	(	const iterator &	row,
		int	column,
		const Glib::ValueBase &	value
	)

overrideprotectedvirtual

Override and implement this in a derived TreeModel class, so that Row::operator() and Row::set_value() work.

Your implementation of set_value_impl() should call row_changed() after changing the value.

Reimplemented from Gtk::TreeModel.

◆ set_visible_column() [1/2]

void Gtk::TreeModelFilter::set_visible_column ( const TreeModelColumnBase & column )

Sets column of the child_model to be the column where filter should look for visibility information.

columns should be a column of type G_TYPE_BOOLEAN, where true means that a row is visible, and false if not.

Note that set_visible_func() or set_visible_column() can only be called once for a given filter model.

Since gtkmm 2.4:

Parameters

column A int which is the column containing the visible information.

◆ set_visible_column() [2/2]

void Gtk::TreeModelFilter::set_visible_column ( int column )

Sets column of the child_model to be the column where filter should look for visibility information.

columns should be a column of type G_TYPE_BOOLEAN, where true means that a row is visible, and false if not.

Note that set_visible_func() or set_visible_column() can only be called once for a given filter model.

Since gtkmm 2.4:

Parameters

column A int which is the column containing the visible information.

◆ set_visible_func()

void Gtk::TreeModelFilter::set_visible_func ( const SlotVisible & slot )

Sets the "visible" callback used when filtering the filter.

The callback function should return true if the given row should be visible and false otherwise.

Parameters

slot	A callback slot which determines whether the row should be visible.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::TreeModelFilter > wrap	(	GtkTreeModelFilter *	object,
		bool	take_copy = `false`
	)

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.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Member Typedef Documentation

◆ SlotModify

◆ SlotVisible

Constructor & Destructor Documentation

◆ TreeModelFilter() [1/3]

◆ ~TreeModelFilter()

◆ TreeModelFilter() [2/3]

◆ TreeModelFilter() [3/3]

Member Function Documentation

◆ clear_cache()

◆ convert_child_iter_to_iter()

◆ convert_child_path_to_path()

◆ convert_iter_to_child_iter()

◆ convert_path_to_child_path()

◆ create() [1/2]

◆ create() [2/2]

◆ get_model() [1/2]

◆ get_model() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_child_model()

◆ property_virtual_root()

◆ refilter()

◆ set_modify_func()

◆ set_value_impl()

◆ set_visible_column() [1/2]

◆ set_visible_column() [2/2]

◆ set_visible_func()

Friends And Related Function Documentation

◆ wrap()