treestore.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREESTORE_H
#define _GTKMM_TREESTORE_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: treestore.hg,v 1.5 2004/04/03 12:53:49 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.
 */
 
// We couldn't include it in treemodel.h, but doing it here makes it easier for people.
#include <gtkmm/treepath.h>
 
#include <gtkmm/treeiter.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/treesortable.h>
#include <gtkmm/treedragdest.h>
#include <gtkmm/treedragsource.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeStore GtkTreeStore;
typedef struct _GtkTreeStoreClass GtkTreeStoreClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TreeStore_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class TreeStore :
  public Glib::Object,
  public Gtk::TreeModel,
  public TreeSortable,
  public TreeDragSource,
  public TreeDragDest
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef TreeStore CppObjectType;
  typedef TreeStore_Class CppClassType;
  typedef GtkTreeStore BaseObjectType;
  typedef GtkTreeStoreClass BaseClassType;
 
private:  friend class TreeStore_Class;
  static CppClassType treestore_class_;
 
private:
  // noncopyable
  TreeStore(const TreeStore&);
  TreeStore& operator=(const TreeStore&);
 
protected:
  explicit TreeStore(const Glib::ConstructParams& construct_params);
  explicit TreeStore(GtkTreeStore* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~TreeStore();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkTreeStore*       gobj()       { return reinterpret_cast<GtkTreeStore*>(gobject_); }
 
  const GtkTreeStore* gobj() const { return reinterpret_cast<GtkTreeStore*>(gobject_); }
 
  GtkTreeStore* gobj_copy();
 
private:
 
  
protected:
  TreeStore();
 
  explicit TreeStore(const TreeModelColumnRecord& columns);
 
public:
  static Glib::RefPtr<TreeStore> create(const TreeModelColumnRecord& columns);
 
 
  void set_column_types(const TreeModelColumnRecord& columns);
  
 
  iterator erase(const iterator& iter);
  
 
  //TODO: Make this documentation similar to documentation for Standard C++ insert methods.
  iterator insert(const iterator& iter);
  
 
  iterator insert_after(const iterator& iter);
  
 
  iterator prepend();
 
  iterator prepend(const TreeNodeChildren& node);
 
 
  iterator append();
 
  iterator append(const TreeNodeChildren& node);
 
  
  void iter_swap(const iterator& a, const iterator& b);
 
  void move(const iterator& source, const iterator& destination);
 
  void reorder(const TreeNodeChildren& node, const Glib::ArrayHandle<int>& new_order);
 
  
  void clear();
  
  bool is_ancestor(const iterator& iter, const iterator& descendant) const;
  
  int iter_depth(const iterator& iter) const;
 
  
  bool iter_is_valid(const iterator& iter) const;
 
protected:
  virtual void set_value_impl(const iterator& row, int column, const Glib::ValueBase& value);
  
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::TreeStore> wrap(GtkTreeStore* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_TREESTORE_H */