treesortable.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREESORTABLE_H
#define _GTKMM_TREESORTABLE_H
 
#include <gtkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: treesortable.hg,v 1.8 2006/04/21 07:41: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.
 */
 
// This is for including the config header before any code (such as
// the #ifndef GTKMM_DISABLE_DEPRECATED in deprecated classes) is generated:
 
 
#include <glibmm/interface.h>
#include <gtkmm/enums.h>
#include <gtkmm/treemodelcolumn.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/treeiter.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C"
{
typedef struct _GtkTreeSortableIface GtkTreeSortableIface;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeSortable GtkTreeSortable;
typedef struct _GtkTreeSortableClass GtkTreeSortableClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TreeSortable_Class; } // namespace Gtk
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
//TODO: This should maybe derive from TreeModel, because it is a prerequisite. murrayc
 
class TreeSortable : public Glib::Interface
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef TreeSortable CppObjectType;
  typedef TreeSortable_Class CppClassType;
  typedef GtkTreeSortable BaseObjectType;
  typedef GtkTreeSortableIface BaseClassType;
 
private:
  friend class TreeSortable_Class;
  static CppClassType treesortable_class_;
 
  // noncopyable
  TreeSortable(const TreeSortable&);
  TreeSortable& operator=(const TreeSortable&);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
  TreeSortable();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  explicit TreeSortable(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 TreeSortable(GtkTreeSortable* castitem);
 
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~TreeSortable();
 
  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
 
  GtkTreeSortable*       gobj()       { return reinterpret_cast<GtkTreeSortable*>(gobject_); }
 
  const GtkTreeSortable* gobj() const { return reinterpret_cast<GtkTreeSortable*>(gobject_); }
 
private:
 
 
public:
 
  enum
  {
    DEFAULT_SORT_COLUMN_ID = -1,
    DEFAULT_UNSORTED_COLUMN_ID = -2
  }; //See GTK+ implementation.
 
  
  bool get_sort_column_id(int& sort_column_id, SortType& order) const;
 
  
  void set_sort_column(const TreeModelColumnBase& sort_column_id, SortType order);
  
  void set_sort_column(int sort_column_id, SortType order);
 
  #ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_sort_column_id(const TreeModelColumnBase& sort_column_id, SortType order);
 
  void set_sort_column_id(int sort_column_id, SortType order);
  #endif // GTKMM_DISABLE_DEPRECATED
 
 
  typedef sigc::slot<int, const Gtk::TreeModel::iterator&, const Gtk::TreeModel::iterator&> SlotCompare;
 
  
  void set_sort_func(const TreeModelColumnBase& sort_column, const SlotCompare& slot);
 
  void set_sort_func(int sort_column_id, const SlotCompare& slot);
 
  void set_default_sort_func(const SlotCompare& slot);
 
  void unset_default_sort_func();
 
  
  bool has_default_sort_func() const;
 
  
  void sort_column_changed();
  
  Glib::SignalProxy0< void > signal_sort_column_changed();
 
 
protected:
    virtual bool get_sort_column_id_vfunc(int* sort_column_id, SortType* order) const;
 
    virtual void set_sort_column_id_vfunc(int sort_column_id, SortType order);
 
    virtual void set_sort_func_vfunc(int sort_column_id, GtkTreeIterCompareFunc func, void* data, GDestroyNotify destroy);
 
    virtual void set_default_sort_func_vfunc(GtkTreeIterCompareFunc func, void* data, GDestroyNotify destroy);
 
    virtual bool has_default_sort_func_vfunc() const;
 
    virtual void sort_column_changed_vfunc() const;
 
 
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_sort_column_changed();
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::TreeSortable> wrap(GtkTreeSortable* object, bool take_copy = false);
 
} // namespace Glib
 
 
#endif /* _GTKMM_TREESORTABLE_H */