A path is essentially a potential node. More...

#include <gtkmm/treepath.h>

Public Types
typedef unsigned int	size_type

typedef int	difference_type

typedef int	value_type

typedef int &	reference

typedef const int &	const_reference

typedef int *	iterator

typedef const int *	const_iterator

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

typedef const void *	BoolExpr
	This typedef is just to make it more obvious that our operator const void* should be used like operator bool(). More...

Public Member Functions
	TreePath ()

	TreePath (const TreePath & other)

TreePath &	operator= (const TreePath & other)

	TreePath (TreePath && other) noexcept

TreePath &	operator= (TreePath && other) noexcept

	~TreePath () noexcept

void	swap (TreePath & other) noexcept

GtkTreePath *	gobj ()
	Provides access to the underlying C instance. More...

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

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

	TreePath (GtkTreePath * gobject, bool make_a_copy=true)

	TreePath (size_type n, value_type value=0)

	TreePath (const Glib::ustring & path)

	TreePath (const TreeModel::iterator & iter)

template<class In >
	TreePath (In pbegin, In pend)

void	clear ()

TreePath &	operator= (const TreeModel::iterator & iter)

	operator BoolExpr () const
	Checks that the path is not empty, by calling empty(). More...

	operator bool () const
	Checks that the path is not empty, by calling empty(). More...

template<class In >
void	assign (In pbegin, In pend)

template<class In >
void	append (In pbegin, In pend)

void	push_back (int index)
	Appends a new index to a path. More...

void	push_front (int index)
	Prepends a new index to a path. More...

size_type	size () const

bool	empty () const

reference	operator[] (size_type i)

const_reference	operator[] (size_type i) const

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

reverse_iterator	rbegin ()

reverse_iterator	rend ()

const_reverse_iterator	rbegin () const

const_reverse_iterator	rend () const

reference	front ()

const_reference	front () const

reference	back ()

const_reference	back () const

void	next ()
	Moves the path to point to the next node at the current depth. More...

bool	prev ()
	Moves the path to point to the previous node at the current depth, if it exists. More...

bool	up ()
	Moves the path to point to its parent node, if it has a parent. More...

void	down ()
	Moves path to point to the first child of the current path. More...

bool	is_ancestor (const TreePath & descendant) const
	Returns `true` if descendant is a descendant of path. More...

bool	is_descendant (const TreePath & ancestor) const
	Returns `true` if path is a descendant of ancestor. More...

Glib::ustring	to_string () const
	Generates a string representation of the path. More...

bool	set_in_selection_data (SelectionData & selection_data, const Glib::RefPtr< const TreeModel > & model) const
	Sets selection data of target type "GTK_TREE_MODEL_ROW". More...

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

static bool	get_from_selection_data (const SelectionData & selection_data, Glib::RefPtr< TreeModel > & model, TreePath & path)
	Obtains a Gtk::TreeModel and Gtk::TreeModel::Path from selection data of target type "GTK_TREE_MODEL_ROW". More...

static bool	get_from_selection_data (const SelectionData & selection_data, TreePath & path)
	See description in the other overload. More...

Protected Attributes
GtkTreePath *	gobject_

Related Functions
(Note that these are not member functions.)
bool	operator== (const TreePath & lhs, const TreePath & rhs)

bool	operator!= (const TreePath & lhs, const TreePath & rhs)

bool	operator< (const TreePath & lhs, const TreePath & rhs)

bool	operator> (const TreePath & lhs, const TreePath & rhs)

bool	operator<= (const TreePath & lhs, const TreePath & rhs)

bool	operator>= (const TreePath & lhs, const TreePath & rhs)

void	swap (TreePath & lhs, TreePath & rhs) noexcept

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

Detailed Description

A path is essentially a potential node.

It is a location on a model that may or may not actually correspond to a node on a specific model.

A Path can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path "0" refers to the root node and the path "2:4" refers to the fifth child of the third node.

Typedefed as Gtk::TreeModel::Path.

Member Typedef Documentation

◆ BoolExpr

typedef const void* Gtk::TreePath::BoolExpr

This typedef is just to make it more obvious that our operator const void* should be used like operator bool().

Deprecated:: Use the explicit operator bool() instead.

◆ const_iterator

typedef const int* Gtk::TreePath::const_iterator

◆ const_reference

typedef const int& Gtk::TreePath::const_reference

◆ const_reverse_iterator

typedef std::reverse_iterator<const_iterator> Gtk::TreePath::const_reverse_iterator

◆ difference_type

typedef int Gtk::TreePath::difference_type

◆ iterator

typedef int* Gtk::TreePath::iterator

◆ reference

typedef int& Gtk::TreePath::reference

◆ reverse_iterator

typedef std::reverse_iterator<iterator> Gtk::TreePath::reverse_iterator

◆ size_type

typedef unsigned int Gtk::TreePath::size_type

◆ value_type

typedef int Gtk::TreePath::value_type

Constructor & Destructor Documentation

◆ TreePath() [1/8]

Gtk::TreePath::TreePath ( )

◆ TreePath() [2/8]

Gtk::TreePath::TreePath ( const TreePath & other )

◆ TreePath() [3/8]

Gtk::TreePath::TreePath ( TreePath && other )

noexcept

◆ ~TreePath()

Gtk::TreePath::~TreePath ( )

noexcept

◆ TreePath() [4/8]

Gtk::TreePath::TreePath	(	GtkTreePath *	gobject,
		bool	make_a_copy = `true`
	)

explicit

◆ TreePath() [5/8]

Gtk::TreePath::TreePath	(	size_type	n,
		value_type	value = `0`
	)

explicit

◆ TreePath() [6/8]

Gtk::TreePath::TreePath ( const Glib::ustring & path )

explicit

◆ TreePath() [7/8]

Gtk::TreePath::TreePath ( const TreeModel::iterator & iter )

explicit

◆ TreePath() [8/8]

template <class In >

Gtk::TreePath::TreePath	(	In	pbegin,
		In	pend
	)

inline

Member Function Documentation

◆ append()

template <class In >

void Gtk::TreePath::append	(	In	pbegin,
		In	pend
	)

◆ assign()

template <class In >

void Gtk::TreePath::assign	(	In	pbegin,
		In	pend
	)

inline

◆ back() [1/2]

reference Gtk::TreePath::back ( )

inline

◆ back() [2/2]

const_reference Gtk::TreePath::back ( ) const

inline

◆ begin() [1/2]

iterator Gtk::TreePath::begin ( )

◆ begin() [2/2]

const_iterator Gtk::TreePath::begin ( ) const

◆ clear()

void Gtk::TreePath::clear ( )

◆ down()

void Gtk::TreePath::down ( )

Moves path to point to the first child of the current path.

◆ empty()

bool Gtk::TreePath::empty ( ) const

◆ end() [1/2]

iterator Gtk::TreePath::end ( )

◆ end() [2/2]

const_iterator Gtk::TreePath::end ( ) const

◆ front() [1/2]

reference Gtk::TreePath::front ( )

inline

◆ front() [2/2]

const_reference Gtk::TreePath::front ( ) const

inline

◆ get_from_selection_data() [1/2]

static bool Gtk::TreePath::get_from_selection_data	(	const SelectionData &	selection_data,
		Glib::RefPtr< TreeModel > &	model,
		TreePath &	path
	)

static

Obtains a Gtk::TreeModel and Gtk::TreeModel::Path from selection data of target type "GTK_TREE_MODEL_ROW".

Normally called from a drag_data_received handler. This function can only be used if selection_data originates from the same process that's calling this function, because a pointer to the tree model is being passed around. If you aren't in the same process, then you'll get memory corruption. In the Gtk::TreeDragDest drag_data_received signal handler, you can assume that selection data of type "GTK_TREE_MODEL_ROW" is from the current process.

Parameters

selection_data	a #SelectionData
model	a Gtk::TreeModel
path	a row in model

Returns: true if the selection_data had target type "GTK_TREE_MODEL_ROW" and is otherwise valid

◆ get_from_selection_data() [2/2]

static bool Gtk::TreePath::get_from_selection_data	(	const SelectionData &	selection_data,
		TreePath &	path
	)

static

See description in the other overload.

◆ get_type()

static GType Gtk::TreePath::get_type ( )

static

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

◆ gobj() [1/2]

GtkTreePath * Gtk::TreePath::gobj ( )

inline

Provides access to the underlying C instance.

◆ gobj() [2/2]

const GtkTreePath * Gtk::TreePath::gobj ( ) const

inline

Provides access to the underlying C instance.

◆ gobj_copy()

GtkTreePath * Gtk::TreePath::gobj_copy ( ) const

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

◆ is_ancestor()

bool Gtk::TreePath::is_ancestor ( const TreePath & descendant ) const

Returns true if descendant is a descendant of path.

Parameters

descendant Another Gtk::TreePath-struct.

Returns: true if descendant is contained inside path.

◆ is_descendant()

bool Gtk::TreePath::is_descendant ( const TreePath & ancestor ) const

Returns true if path is a descendant of ancestor.

Parameters

ancestor Another Gtk::TreePath-struct.

Returns: true if ancestor contains path somewhere below it.

◆ next()

void Gtk::TreePath::next ( )

Moves the path to point to the next node at the current depth.

◆ operator bool()

Gtk::TreePath::operator bool ( ) const

explicit

Checks that the path is not empty, by calling empty().

For instance,

if(treepath)

do_something()

Since gtkmm 3.22:

◆ operator BoolExpr()

Gtk::TreePath::operator BoolExpr ( ) const

Checks that the path is not empty, by calling empty().

For instance,

if(treepath)

do_something()

Deprecated:: Use the explicit operator bool() instead.

Since gtkmm 2.16:

◆ operator=() [1/3]

TreePath & Gtk::TreePath::operator= ( const TreeModel::iterator & iter )

◆ operator=() [2/3]

TreePath & Gtk::TreePath::operator= ( const TreePath & other )

◆ operator=() [3/3]

TreePath & Gtk::TreePath::operator= ( TreePath && other )

noexcept

◆ operator[]() [1/2]

reference Gtk::TreePath::operator[] ( size_type i )

◆ operator[]() [2/2]

const_reference Gtk::TreePath::operator[] ( size_type i ) const

◆ prev()

bool Gtk::TreePath::prev ( )

Moves the path to point to the previous node at the current depth, if it exists.

Returns: true if path has a previous node, and the move was made.

◆ push_back()

void Gtk::TreePath::push_back ( int index )

Appends a new index to a path.

As a result, the depth of the path is increased.

Parameters

index The index.

◆ push_front()

void Gtk::TreePath::push_front ( int index )

Prepends a new index to a path.

As a result, the depth of the path is increased.

Parameters

index The index.

◆ rbegin() [1/2]

reverse_iterator Gtk::TreePath::rbegin ( )

inline

◆ rbegin() [2/2]

const_reverse_iterator Gtk::TreePath::rbegin ( ) const

inline

◆ rend() [1/2]

reverse_iterator Gtk::TreePath::rend ( )

inline

◆ rend() [2/2]

const_reverse_iterator Gtk::TreePath::rend ( ) const

inline

◆ set_in_selection_data()

bool Gtk::TreePath::set_in_selection_data	(	SelectionData &	selection_data,
		const Glib::RefPtr< const TreeModel > &	model
	)		const

Sets selection data of target type "GTK_TREE_MODEL_ROW".

Normally used in a drag_data_get signal handler.

Parameters

selection_data	some #SelectionData
model	a Gtk::TreeModel

Returns: true if the selection_data had the proper target type to allow us to set a tree row

◆ size()

size_type Gtk::TreePath::size ( ) const

◆ swap()

void Gtk::TreePath::swap ( TreePath & other )

noexcept

◆ to_string()

Glib::ustring Gtk::TreePath::to_string ( ) const

Generates a string representation of the path.

This string is a “:” separated list of numbers. For example, “4:10:0:3” would be an acceptable return value for this string.

Returns: The string.

◆ up()

bool Gtk::TreePath::up ( )

Moves the path to point to its parent node, if it has a parent.

Returns: true if path has a parent, and the move was made.

Friends And Related Function Documentation

◆ operator!=()

bool operator!=	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ operator<()

bool operator<	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ operator<=()

bool operator<=	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ operator==()

bool operator==	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ operator>()

bool operator>	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ operator>=()

bool operator>=	(	const TreePath &	lhs,
		const TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

Returns: The result

◆ swap()

void swap	(	TreePath &	lhs,
		TreePath &	rhs
	)

lhs	The left-hand side
rhs	The right-hand side

◆ wrap()

Gtk::TreePath wrap	(	GtkTreePath *	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.

Member Data Documentation

◆ gobject_

GtkTreePath* Gtk::TreePath::gobject_

protected

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Related Functions

Detailed Description

Member Typedef Documentation

◆ BoolExpr

◆ const_iterator

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ iterator

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ TreePath() [1/8]

◆ TreePath() [2/8]

◆ TreePath() [3/8]

◆ ~TreePath()

◆ TreePath() [4/8]

◆ TreePath() [5/8]

◆ TreePath() [6/8]

◆ TreePath() [7/8]

◆ TreePath() [8/8]

Member Function Documentation

◆ append()

◆ assign()

◆ back() [1/2]

◆ back() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ down()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ front() [1/2]

◆ front() [2/2]

◆ get_from_selection_data() [1/2]

◆ get_from_selection_data() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ is_ancestor()

◆ is_descendant()

◆ next()

◆ operator bool()

◆ operator BoolExpr()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ prev()

◆ push_back()

◆ push_front()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ set_in_selection_data()

◆ size()

◆ swap()

◆ to_string()

◆ up()

Friends And Related Function Documentation

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ swap()

◆ wrap()

Member Data Documentation

◆ gobject_