|
gtkmm 4.16.0
|
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 |
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. | |
| const GtkTreePath * | gobj () const |
| Provides access to the underlying C instance. | |
| 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. | |
| 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) | |
| TreePath (const TreeModel::const_iterator &iter) | |
| template<class In > | |
| TreePath (In pbegin, In pend) | |
| void | clear () |
| TreePath & | operator= (const TreeModel::iterator &iter) |
| TreePath & | operator= (const TreeModel::const_iterator &iter) |
| operator bool () const | |
| Checks that the path is not empty, by calling empty(). | |
| 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. | |
| void | push_front (int index) |
| Prepends a new index to a path. | |
| 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. | |
| bool | prev () |
| Moves the path to point to the previous node at the current depth, if it exists. | |
| bool | up () |
| Moves the path to point to its parent node, if it has a parent. | |
| void | down () |
| Moves path to point to the first child of the current path. | |
| bool | is_ancestor (const TreePath &descendant) const |
Returns true if descendant is a descendant of path. | |
| bool | is_descendant (const TreePath &ancestor) const |
Returns true if path is a descendant of ancestor. | |
| Glib::ustring | to_string () const |
| Generates a string representation of the path. | |
| Glib::RefPtr< Gdk::ContentProvider > | create_row_drag_content (const Glib::RefPtr< const TreeModel > &model) const |
| Creates a content provider for dragging the path from model. | |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. | |
| static bool | get_row_drag_data (const Glib::ValueBase & value, Glib::RefPtr< const TreeModel > &model, TreePath & path) |
| Obtains a Gtk::TreeModel and Gtk::TreeModel::Path from value of target type GTK_TYPE_TREE_ROW_DATA. | |
| static bool | get_row_drag_data (const Glib::ValueBase & value, TreePath & path) |
| See description in the other overload. | |
Protected Attributes | |
| GtkTreePath * | gobject_ |
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.
| Gtk::TreePath::TreePath | ( | ) |
|
noexcept |
|
noexcept |
|
explicit |
|
explicit |
|
explicit |
|
explicit |
|
explicit |
|
inline |
|
inline |
| iterator Gtk::TreePath::begin | ( | ) |
| const_iterator Gtk::TreePath::begin | ( | ) | const |
| void Gtk::TreePath::clear | ( | ) |
| Glib::RefPtr< Gdk::ContentProvider > Gtk::TreePath::create_row_drag_content | ( | const Glib::RefPtr< const TreeModel > & | model | ) | const |
Creates a content provider for dragging the path from model.
| model | A Gtk::TreeModel. |
| void Gtk::TreePath::down | ( | ) |
Moves path to point to the first child of the current path.
Deprecated: 4.10
| bool Gtk::TreePath::empty | ( | ) | const |
| iterator Gtk::TreePath::end | ( | ) |
| const_iterator Gtk::TreePath::end | ( | ) | const |
|
inline |
|
inline |
|
static |
Obtains a Gtk::TreeModel and Gtk::TreeModel::Path from value of target type GTK_TYPE_TREE_ROW_DATA.
| value | A Glib::ValueBase | |
| [out] | model | A Gtk::TreeModel |
| [out] | path | A row in model |
true if the value had target type GTK_TYPE_TREE_ROW_DATA and is otherwise valid.
|
static |
See description in the other overload.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C instance.
|
inline |
Provides access to the underlying C instance.
| 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.
Returns true if descendant is a descendant of path.
Deprecated: 4.10
| descendant | Another Gtk::TreePath. |
true if descendant is contained inside path. Returns true if path is a descendant of ancestor.
Deprecated: 4.10
| ancestor | Another Gtk::TreePath. |
true if ancestor contains path somewhere below it. | void Gtk::TreePath::next | ( | ) |
Moves the path to point to the next node at the current depth.
Deprecated: 4.10
|
explicit |
| TreePath & Gtk::TreePath::operator= | ( | const TreeModel::const_iterator & | iter | ) |
| TreePath & Gtk::TreePath::operator= | ( | const TreeModel::iterator & | iter | ) |
| const_reference Gtk::TreePath::operator[] | ( | size_type | i | ) | const |
| bool Gtk::TreePath::prev | ( | ) |
Moves the path to point to the previous node at the current depth, if it exists.
Deprecated: 4.10
true if path has a previous node, and the move was made. | void Gtk::TreePath::push_back | ( | int | index | ) |
Appends a new index to a path.
As a result, the depth of the path is increased.
Deprecated: 4.10
| index | The index. |
| void Gtk::TreePath::push_front | ( | int | index | ) |
Prepends a new index to a path.
As a result, the depth of the path is increased.
Deprecated: 4.10
| index | The index. |
|
inline |
|
inline |
|
inline |
|
inline |
| size_type Gtk::TreePath::size | ( | ) | const |
| 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. If the path has depth 0, nullptr is returned.
Deprecated: 4.10
| bool Gtk::TreePath::up | ( | ) |
Moves the path to point to its parent node, if it has a parent.
Deprecated: 4.10
true if path has a parent, and the move was made.
|
protected |