treepath.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREEPATH_H
#define _GTKMM_TREEPATH_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: treepath.hg,v 1.15 2006/02/25 12:38:11 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.
 */
 
// This is for including the config header before any code (such as
// the #ifndef GTKMM_DISABLE_DEPRECATED in deprecated classes) is generated:
 
 
#include <gtkmm/selectiondata.h>
#include <gtkmm/treemodel.h>
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GtkTreePath GtkTreePath; }
#endif
 
namespace Gtk
{
 
class TreePath
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef TreePath CppObjectType;
  typedef GtkTreePath BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  static GType get_type() G_GNUC_CONST;
 
  TreePath();
 
  explicit TreePath(GtkTreePath* gobject, bool make_a_copy = true);
 
  TreePath(const TreePath& other);
  TreePath& operator=(const TreePath& other);
 
  ~TreePath();
 
  void swap(TreePath& other);
 
  GtkTreePath*       gobj()       { return gobject_; }
 
  const GtkTreePath* gobj() const { return gobject_; }
 
  GtkTreePath* gobj_copy() const;
 
protected:
  GtkTreePath* gobject_;
 
private:
 
  
public:
  typedef unsigned int  size_type;
  typedef int           difference_type;
 
  typedef int           value_type;
  typedef int&          reference;
  typedef const int&    const_reference;
 
  // Use plain pointers for simplicity.
  typedef int*          iterator;
  typedef const int*    const_iterator;
 
#ifndef GLIBMM_HAVE_SUN_REVERSE_ITERATOR
 
  typedef std::reverse_iterator<iterator>       reverse_iterator;
  typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 
#else
 
  typedef std::reverse_iterator<iterator, std::random_access_iterator_tag,
                                int, int&, int*, ptrdiff_t> reverse_iterator;
 
  typedef std::reverse_iterator<const_iterator, std::random_access_iterator_tag,
                                int, const int&, const int*, ptrdiff_t> const_reverse_iterator;
 
#endif /* GLIBMM_HAVE_SUN_REVERSE_ITERATOR */
 
  explicit TreePath(size_type n, value_type value = 0);
  explicit TreePath(const Glib::ustring& path);
  explicit TreePath(const TreeModel::iterator& iter);
 
  template <class In> inline TreePath(In pbegin, In pend);
 
  void clear();
 
  // I think it's OK for this assignment to be implicit.  It's very useful.
  TreePath& operator=(const TreeModel::iterator& iter);
 
  operator bool() const;
 
  template <class In> inline void assign(In pbegin, In pend);
  template <class In>        void append(In pbegin, In pend);
 
  
  void push_back(int index);
  
  void push_front(int index);
 
  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;
 
  // Note: there is no advantage in not inlining these methods.
  // We can't change them without breaking ABI anyway.
  reverse_iterator       rbegin()       { return reverse_iterator(end());         }
  reverse_iterator       rend()         { return reverse_iterator(begin());       }
  const_reverse_iterator rbegin() const { return const_reverse_iterator(end());   }
  const_reverse_iterator rend()   const { return const_reverse_iterator(begin()); }
 
  reference       front()       { return *begin();  }
  const_reference front() const { return *begin();  }
  reference       back()        { return *rbegin(); }
  const_reference back()  const { return *rbegin(); }
 
  
  void next();
  
  bool prev();
  
  bool up();
  
  void down();
 
  
  bool is_ancestor(const TreePath& descendant) const;
  
  bool is_descendant(const TreePath& ancestor) const;
 
  
  Glib::ustring to_string() const;
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void append_index(int index);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void prepend_index(int index);
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  int get_depth() const;
#endif // GTKMM_DISABLE_DEPRECATED
 
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  Glib::ArrayHandle<int> get_indices() const;
#endif // GTKMM_DISABLE_DEPRECATED
 
  
  static bool get_from_selection_data(const SelectionData& selection_data, Glib::RefPtr<TreeModel>& model, TreePath& path);
  //TODO: Add an override that takes a const TreeModel (and deprecate the current version).
 
  static bool get_from_selection_data(const SelectionData& selection_data, TreePath& path);
 
  bool set_in_selection_data(SelectionData& selection_data, const Glib::RefPtr<const TreeModel>& model) const;
 
 
};
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
template <class In>
void TreePath::append(In pbegin, In pend)
{
  // push_back() can't throw -- if it could, this code wouldn't be strongly exception-safe.
  for(; pbegin != pend; ++pbegin)
    this->push_back(*pbegin);
}
 
template <class In> inline
TreePath::TreePath(In pbegin, In pend)
{
  this->append(pbegin, pend);
}
 
template <class In> inline
void TreePath::assign(In pbegin, In pend)
{
  TreePath temp (pbegin, pend);
  this->swap(temp);
}
 
 
/* Traits for use of TreePath in a Glib::ListHandle<>.
 */
struct TreePath_Traits
{
  typedef TreePath            CppType;
  typedef const GtkTreePath*  CType;
  typedef GtkTreePath*        CTypeNonConst;
 
  static CType to_c_type(const CppType& item)
    { return item.gobj(); }
 
  static CType to_c_type(CType item)
    { return item; }
 
  static CppType to_cpp_type(CType item)
    { return CppType(const_cast<CTypeNonConst>(item)); }
 
  static void release_c_type(CType item)
    { gtk_tree_path_free(const_cast<CTypeNonConst>(item)); }
};
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
} // namespace Gtk
 
 
namespace Gtk
{
 
bool operator==(const TreePath& lhs, const TreePath& rhs);
 
bool operator!=(const TreePath& lhs, const TreePath& rhs);
 
bool operator<(const TreePath& lhs, const TreePath& rhs);
 
bool operator>(const TreePath& lhs, const TreePath& rhs);
 
bool operator<=(const TreePath& lhs, const TreePath& rhs);
 
bool operator>=(const TreePath& lhs, const TreePath& rhs);
 
 
} // namespace Gtk
 
 
namespace Gtk
{
 
inline void swap(TreePath& lhs, TreePath& rhs)
  { lhs.swap(rhs); }
 
} // namespace Gtk
 
namespace Glib
{
 
Gtk::TreePath wrap(GtkTreePath* object, bool take_copy = false);
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
template <>
class Value<Gtk::TreePath> : public Glib::Value_Boxed<Gtk::TreePath>
{};
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
} // namespace Glib
 
 
#endif /* _GTKMM_TREEPATH_H */