13
0
livetrax/libs/gtkmm2/gtk/gtkmm/treerowreference.h
Paul Davis 449aab3c46 rollback to 3428, before the mysterious removal of libs/* at 3431/3432
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
2008-06-02 21:41:35 +00:00

157 lines
3.9 KiB
C++

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_TREEROWREFERENCE_H
#define _GTKMM_TREEROWREFERENCE_H
#include <glibmm.h>
/* $Id$ */
/* Copyright (C) 2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gtkmm/treemodel.h>
#include <gtkmm/treepath.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GtkTreeRowReference GtkTreeRowReference; }
#endif
namespace Gtk
{
/** 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.
* @ingroup TreeView
*/
class TreeRowReference
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef TreeRowReference CppObjectType;
typedef GtkTreeRowReference BaseObjectType;
static GType get_type() G_GNUC_CONST;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
TreeRowReference();
explicit TreeRowReference(GtkTreeRowReference* gobject, bool make_a_copy = true);
TreeRowReference(const TreeRowReference& other);
TreeRowReference& operator=(const TreeRowReference& other);
~TreeRowReference();
void swap(TreeRowReference& other);
///Provides access to the underlying C instance.
GtkTreeRowReference* gobj() { return gobject_; }
///Provides access to the underlying C instance.
const GtkTreeRowReference* gobj() const { return gobject_; }
///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
GtkTreeRowReference* gobj_copy() const;
protected:
GtkTreeRowReference* gobject_;
private:
public:
TreeRowReference(const Glib::RefPtr<TreeModel>& model, const TreeModel::Path& path);
///The same as is_valid().
operator bool() const;
/** Return value: A current path, or <tt>0</tt>.
* @return A current path, or <tt>0</tt>.
*/
TreeModel::Path get_path() const;
/** Return value: the model
* @return The model
*
* @newin2p8.
*/
Glib::RefPtr<TreeModel> get_model();
/** Return value: the model
* @return The model
*
* @newin2p8.
*/
Glib::RefPtr<const TreeModel> get_model() const;
/** Return value: <tt>true</tt> if @a reference points to a valid path.
* @return <tt>true</tt> if @a reference points to a valid path.
*/
bool is_valid() const;
};
} // namespace Gtk
namespace Gtk
{
/** @relates Gtk::TreeRowReference
* @param lhs The left-hand side
* @param rhs The right-hand side
*/
inline void swap(TreeRowReference& lhs, TreeRowReference& rhs)
{ lhs.swap(rhs); }
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::TreeRowReference
*/
Gtk::TreeRowReference wrap(GtkTreeRowReference* object, bool take_copy = false);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class Value<Gtk::TreeRowReference> : public Glib::Value_Boxed<Gtk::TreeRowReference>
{};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
} // namespace Glib
#endif /* _GTKMM_TREEROWREFERENCE_H */