Ardour  9.0-pre0-582-g084a23a80d
Gtk::TreeRowReference Class Reference

#include <treerowreference.h>

Public Member Functions

 TreeRowReference ()
 
 TreeRowReference (GtkTreeRowReference *gobject, bool make_a_copy=true)
 
 TreeRowReference (const TreeRowReference &other)
 
TreeRowReferenceoperator= (const TreeRowReference &other)
 
 ~TreeRowReference ()
 
void swap (TreeRowReference &other)
 
GtkTreeRowReferencegobj ()
 Provides access to the underlying C instance. More...
 
const GtkTreeRowReferencegobj () const
 Provides access to the underlying C instance. More...
 
GtkTreeRowReferencegobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More...
 
 TreeRowReference (const Glib::RefPtr< TreeModel > &model, const TreeModel::Path &path)
 
 operator bool () const
 The same as is_valid(). More...
 
TreeModel::Path get_path () const
 
Glib::RefPtr< TreeModelget_model ()
 
Glib::RefPtr< const TreeModelget_model () const
 
bool is_valid () const
 

Static Public Member Functions

static GType get_type () G_GNUC_CONST
 

Protected Attributes

GtkTreeRowReferencegobject_
 

Related Functions

(Note that these are not member functions.)

void swap (TreeRowReference &lhs, TreeRowReference &rhs)
 
Gtk::TreeRowReference wrap (GtkTreeRowReference *object, bool take_copy=false)
 

Detailed Description

Typedefed as Gtk::TreeModel::RowReference. This reference will keep pointing to the node pointed to by the Path, so long as it exists. It listens to all signals emitted by the Model, and updates its Path appropriately.

Definition at line 46 of file treerowreference.h.

Constructor & Destructor Documentation

◆ TreeRowReference() [1/4]

Gtk::TreeRowReference::TreeRowReference ( )

◆ TreeRowReference() [2/4]

Gtk::TreeRowReference::TreeRowReference ( GtkTreeRowReference gobject,
bool  make_a_copy = true 
)
explicit

◆ TreeRowReference() [3/4]

Gtk::TreeRowReference::TreeRowReference ( const TreeRowReference other)

◆ ~TreeRowReference()

Gtk::TreeRowReference::~TreeRowReference ( )

◆ TreeRowReference() [4/4]

Gtk::TreeRowReference::TreeRowReference ( const Glib::RefPtr< TreeModel > &  model,
const TreeModel::Path path 
)

Member Function Documentation

◆ get_model() [1/2]

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

Returns the model that the row reference is monitoring.

Returns
The model.

◆ get_model() [2/2]

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

Returns the model that the row reference is monitoring.

Returns
The model.

◆ get_path()

TreeModel::Path Gtk::TreeRowReference::get_path ( ) const

Returns a path that the row reference currently points to, or 0 if the path pointed to is no longer valid.

Returns
A current path, or 0.

◆ get_type()

static GType Gtk::TreeRowReference::get_type ( )
static

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

◆ gobj() [1/2]

GtkTreeRowReference* Gtk::TreeRowReference::gobj ( )
inline

Provides access to the underlying C instance.

Definition at line 70 of file treerowreference.h.

◆ gobj() [2/2]

const GtkTreeRowReference* Gtk::TreeRowReference::gobj ( ) const
inline

Provides access to the underlying C instance.

Definition at line 73 of file treerowreference.h.

◆ gobj_copy()

GtkTreeRowReference* Gtk::TreeRowReference::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_valid()

bool Gtk::TreeRowReference::is_valid ( ) const

Returns true if the reference is non-0 and refers to a current valid path.

Returns
true if reference points to a valid path.

◆ operator bool()

Gtk::TreeRowReference::operator bool ( ) const

The same as is_valid().

◆ operator=()

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

◆ swap()

void Gtk::TreeRowReference::swap ( TreeRowReference other)

Friends And Related Function Documentation

◆ swap()

void swap ( TreeRowReference lhs,
TreeRowReference rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side

Definition at line 132 of file treerowreference.h.

◆ wrap()

Gtk::TreeRowReference wrap ( GtkTreeRowReference object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

Member Data Documentation

◆ gobject_

GtkTreeRowReference* Gtk::TreeRowReference::gobject_
protected

Definition at line 79 of file treerowreference.h.


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