treemodel.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREEMODEL_H
#define _GTKMM_TREEMODEL_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: treemodel.hg,v 1.25 2006/05/10 20:59:28 murrayc Exp $ */
 
/* Copyright (C) 1998-2002 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <glibmm/interface.h>
#include <glibmm/arrayhandle.h>
#include <gtkmm/treeiter.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeModel GtkTreeModel;
typedef struct _GtkTreeModelClass GtkTreeModelClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TreeModel_Class; } // namespace Gtk
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class TreeModelSort;
class TreePath;
class TreeRowReference;
 
 
enum TreeModelFlags
{
  TREE_MODEL_ITERS_PERSIST = 1 << 0,
  TREE_MODEL_LIST_ONLY = 1 << 1
};
 
inline TreeModelFlags operator|(TreeModelFlags lhs, TreeModelFlags rhs)
  { return static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
 
inline TreeModelFlags operator&(TreeModelFlags lhs, TreeModelFlags rhs)
  { return static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
 
inline TreeModelFlags operator^(TreeModelFlags lhs, TreeModelFlags rhs)
  { return static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
 
inline TreeModelFlags operator~(TreeModelFlags flags)
  { return static_cast<TreeModelFlags>(~static_cast<unsigned>(flags)); }
 
inline TreeModelFlags& operator|=(TreeModelFlags& lhs, TreeModelFlags rhs)
  { return (lhs = static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
 
inline TreeModelFlags& operator&=(TreeModelFlags& lhs, TreeModelFlags rhs)
  { return (lhs = static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
 
inline TreeModelFlags& operator^=(TreeModelFlags& lhs, TreeModelFlags rhs)
  { return (lhs = static_cast<TreeModelFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::TreeModelFlags> : public Glib::Value_Flags<Gtk::TreeModelFlags>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
//TODO: Remove any mention of null arguments from the method documentation, by adding overrides in gtk_docs_override.xml.
class TreeModel : public Glib::Interface
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef TreeModel CppObjectType;
  typedef TreeModel_Class CppClassType;
  typedef GtkTreeModel BaseObjectType;
  typedef GtkTreeModelIface BaseClassType;
 
private:
  friend class TreeModel_Class;
  static CppClassType treemodel_class_;
 
  // noncopyable
  TreeModel(const TreeModel&);
  TreeModel& operator=(const TreeModel&);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
  TreeModel();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  explicit TreeModel(const Glib::Interface_Class& interface_class);
 
public:
  // This is public so that C++ wrapper instances can be
  // created for C instances of unwrapped types.
  // For instance, if an unexpected C type implements the C interface. 
  explicit TreeModel(GtkTreeModel* castitem);
 
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~TreeModel();
 
  static void add_interface(GType gtype_implementer);
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkTreeModel*       gobj()       { return reinterpret_cast<GtkTreeModel*>(gobject_); }
 
  const GtkTreeModel* gobj() const { return reinterpret_cast<GtkTreeModel*>(gobject_); }
 
private:
 
  
public:
  typedef TreeModelColumnRecord ColumnRecord;
 
  typedef TreeNodeChildren Children;
  typedef Children::iterator iterator;
  typedef Children::reverse_iterator reverse_iterator;
  typedef Children::const_iterator const_iterator;
  typedef Children::const_reverse_iterator const_reverse_iterator;
 
  typedef TreeRow Row;
  typedef TreePath Path;
  typedef TreeRowReference RowReference;
 
 
  //These are part of GtkTreeModelFilter or GtkTreeModelSort, not GtkTreeModel:
  //gtkmmproc error: gtk_tree_model_filter_sort_new_with_model : ignored method defs lookup failed
 
  iterator get_iter(const Path& path);
  //TODO: Add const_iterator get_iter(const Path& path) const;
  //Implement a const_iterator?
 
  iterator get_iter(const Glib::ustring& path_string);
  //TODO: Implement a const_iterator? const_iterator get_iter(const Glib::ustring& path_string) const;
 
  Children children();
 
  //TODO: Return a real TreeNodeChildren (a container of const_iterators), when we have a real const_iterator.
  Children children() const;
 
  
  typedef sigc::slot<bool, const TreeModel::iterator&> SlotForeachIter;
 
  void foreach_iter(const SlotForeachIter& slot);
 
  typedef sigc::slot<bool, const TreeModel::Path&> SlotForeachPath;
 
  void foreach_path(const SlotForeachPath& slot);
 
  typedef sigc::slot<bool, const TreeModel::Path&, const TreeModel::iterator&> SlotForeachPathAndIter;
 
  void foreach(const SlotForeachPathAndIter& slot);
 
  
  TreeModelFlags get_flags() const;
  
  int get_n_columns() const;
  
  GType get_column_type(int index) const;
  //TODO: A C++-type version of get_column_type()?
 
  
  TreeModel::Path get_path(const iterator& iter) const;
 
  
  void row_changed(const Path& path, const iterator& iter);
  
  void row_inserted(const Path& path, const iterator& iter);
  
  void row_has_child_toggled(const Path& path, const iterator& iter);
  
  void row_deleted(const Path& path);
 
  void rows_reordered(const Path& path, const iterator& iter, const Glib::ArrayHandle<int>& new_order);
 
  void rows_reordered(const Path& path, const Glib::ArrayHandle<int>& new_order);
 
  
  void rows_reordered(const Path& path, const iterator& iter, int* new_order);
 
  
  Glib::ustring get_string(const iterator& iter) const;
 
 
  Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > signal_row_changed();
 
  
  Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > signal_row_inserted();
 
  
  Glib::SignalProxy2< void,const TreeModel::Path&,const TreeModel::iterator& > signal_row_has_child_toggled();
 
  
  Glib::SignalProxy1< void,const TreeModel::Path& > signal_row_deleted();
 
  
  Glib::SignalProxy3< void,const TreeModel::Path&,const TreeModel::iterator&,int* > signal_rows_reordered();
 
 
protected:
    virtual TreeModelFlags get_flags_vfunc() const;
 
    virtual int get_n_columns_vfunc() const;
 
    virtual GType get_column_type_vfunc(int index) const;
 
 
  //These are only for deriving new TreeModels, which isn't very common or easy:
 
  virtual bool iter_next_vfunc(const iterator& iter, iterator& iter_next) const;
 
  virtual bool get_iter_vfunc(const Path& path, iterator& iter) const;
 
  virtual bool iter_children_vfunc(const iterator& parent, iterator& iter) const;
 
  virtual bool iter_parent_vfunc(const iterator& child, iterator& iter) const;
 
  virtual bool iter_nth_child_vfunc(const iterator& parent, int n, iterator& iter) const;
 
  virtual bool iter_nth_root_child_vfunc(int n, iterator& iter) const;
 
 
    virtual bool iter_has_child_vfunc(const iterator& iter) const;
 
 
  virtual int iter_n_children_vfunc(const iterator& iter) const;
 
  virtual int iter_n_root_children_vfunc() const;
 
    virtual void ref_node_vfunc(const iterator& iter) const;
 
 
    virtual void unref_node_vfunc(const iterator& iter) const;
 
 
    virtual TreeModel::Path get_path_vfunc(const iterator& iter) const;
 
 
    virtual void get_value_vfunc(const iterator& iter, int column, Glib::ValueBase& value) const;
 
 
  //We don't put an deprecation ifdef around this because it would break ABI.
  virtual bool iter_is_valid(const iterator& iter) const;
 
  //Called by TreeRow, which is a friend class:
  //The comment about set_row_changed() in the documentation is based on my reading of the source of
  //gtk_list_store_set_value() and gtk_tree_store_set_value().
  virtual void set_value_impl(const iterator& row, int column, const Glib::ValueBase& value);
 
  //This might not need to be virtual, but it's not a big deal. murrayc.
  virtual void get_value_impl(const iterator& row, int column, Glib::ValueBase& value) const;
 
  friend class Gtk::TreeModelSort;
  friend class Gtk::TreeRow;
  friend class Gtk::TreeIter;
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_row_changed(const TreeModel::Path& path, const TreeModel::iterator& iter);
  virtual void on_row_inserted(const TreeModel::Path& path, const TreeModel::iterator& iter);
  virtual void on_row_has_child_toggled(const TreeModel::Path& path, const TreeModel::iterator& iter);
  virtual void on_row_deleted(const TreeModel::Path& path);
  virtual void on_rows_reordered(const TreeModel::Path& path, const TreeModel::iterator& iter, int* new_order);
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::TreeModel> wrap(GtkTreeModel* object, bool take_copy = false);
 
} // namespace Glib
 
 
#endif /* _GTKMM_TREEMODEL_H */