treeselection.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREESELECTION_H
#define _GTKMM_TREESELECTION_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: treeselection.hg,v 1.6 2006/04/12 11:11:25 murrayc Exp $ */
 
/* Copyright(C) 1998-1999 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 <gtkmm/treepath.h>
#include <gtkmm/enums.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/treeiter.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeSelection GtkTreeSelection;
typedef struct _GtkTreeSelectionClass GtkTreeSelectionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TreeSelection_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
class TreeView;
class TreeModel;
class TreePath;
 
class TreeSelection : public Glib::Object
{
   
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef TreeSelection CppObjectType;
  typedef TreeSelection_Class CppClassType;
  typedef GtkTreeSelection BaseObjectType;
  typedef GtkTreeSelectionClass BaseClassType;
 
private:  friend class TreeSelection_Class;
  static CppClassType treeselection_class_;
 
private:
  // noncopyable
  TreeSelection(const TreeSelection&);
  TreeSelection& operator=(const TreeSelection&);
 
protected:
  explicit TreeSelection(const Glib::ConstructParams& construct_params);
  explicit TreeSelection(GtkTreeSelection* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~TreeSelection();
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkTreeSelection*       gobj()       { return reinterpret_cast<GtkTreeSelection*>(gobject_); }
 
  const GtkTreeSelection* gobj() const { return reinterpret_cast<GtkTreeSelection*>(gobject_); }
 
  GtkTreeSelection* gobj_copy();
 
private:
 
   
protected:
 
 
public:
  
  void set_mode(SelectionMode type);
  
  SelectionMode get_mode() const;
 
  typedef sigc::slot<bool, const Glib::RefPtr<TreeModel>&, const TreeModel::Path&, bool> SlotSelect;
 
  void set_select_function(const SlotSelect& slot);
  
 
   // This would be our SignalProxy_Select* data.
 
  
  TreeView* get_tree_view();
  
  const TreeView* get_tree_view() const;
 
  Glib::RefPtr<TreeModel> get_model(); // convenience function, not in GTK+
  Glib::RefPtr<const TreeModel> get_model() const; // convenience function, not in GTK+
 
  //TODO: Add TreeModel::const_iterator get_selected() const, when we have a real const_iterator.
 
  TreeModel::iterator get_selected();
 
  TreeModel::iterator get_selected(Glib::RefPtr<TreeModel>& model);
 
  typedef Glib::ListHandle<TreeModel::Path, TreePath_Traits> ListHandle_Path;
 
  ListHandle_Path get_selected_rows() const;
 
  ListHandle_Path get_selected_rows(Glib::RefPtr<TreeModel>& model);
 
  
  int count_selected_rows() const;
 
  //TODO: Consider deprecating these selected_foreach() methods, because get_selected_rows() should be enough.
 
  //TODO: SlotForEachIter should take a const_iterator, when we have a real const iterator.
  typedef sigc::slot<void, const TreeModel::iterator&> SlotForeachIter;
 
  void selected_foreach_iter(const SlotForeachIter& slot) const;
 
  typedef sigc::slot<void, const TreeModel::Path&> SlotForeachPath;
 
  void selected_foreach_path(const SlotForeachPath& slot) const;
  
 
  typedef sigc::slot<void, const TreeModel::Path&, const TreeModel::iterator&> SlotForeachPathAndIter;
 
  void selected_foreach(const SlotForeachPathAndIter& slot) const;
 
  
  void select(const TreeModel::Path& path);
  
  void select(const TreeModel::iterator& iter);
  
  void select(const TreeModel::Row& row);
  
  void select(const TreeModel::Path& start_path, const TreeModel::Path& end_path);
 
  
  void unselect(const TreeModel::Path& path);
  
  void unselect(const TreeModel::Path& start_path, const TreeModel::Path& end_path);
  
  void unselect(const TreeModel::iterator& iter);
 
  
  bool is_selected(const TreeModel::Path& path) const;
  
  bool is_selected(const TreeModel::iterator& iter) const;
 
  
  void select_all();
  
  void unselect_all();
 
  
  Glib::SignalProxy0< void > signal_changed();
 
 
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_changed();
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::TreeSelection> wrap(GtkTreeSelection* object, bool take_copy = false);
}
 
 
#endif /* _GTKMM_TREESELECTION_H */