iconview.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_ICONVIEW_H
#define _GTKMM_ICONVIEW_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: iconview.hg,v 1.11 2006/07/08 16:31:38 murrayc Exp $ */
 
/* iconview.h
 *
 * Copyright (C) 1998-2004 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/container.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/treepath.h>
#include <gtkmm/cellrenderer.h>
#include <gtkmm/tooltip.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkIconView GtkIconView;
typedef struct _GtkIconViewClass GtkIconViewClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class IconView_Class; } // namespace Gtk
namespace Gtk
{
 
enum IconViewDropPosition
{
  ICON_VIEW_NO_DROP,
  ICON_VIEW_DROP_INTO,
  ICON_VIEW_DROP_LEFT,
  ICON_VIEW_DROP_RIGHT,
  ICON_VIEW_DROP_ABOVE,
  ICON_VIEW_DROP_BELOW
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::IconViewDropPosition> : public Glib::Value_Enum<Gtk::IconViewDropPosition>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
//TODO: This should derive+implement from CellLayout when we can break ABI.
 
class IconView : public Container
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef IconView CppObjectType;
  typedef IconView_Class CppClassType;
  typedef GtkIconView BaseObjectType;
  typedef GtkIconViewClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~IconView();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class IconView_Class;
  static CppClassType iconview_class_;
 
  // noncopyable
  IconView(const IconView&);
  IconView& operator=(const IconView&);
 
protected:
  explicit IconView(const Glib::ConstructParams& construct_params);
  explicit IconView(GtkIconView* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
 
 
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkIconView*       gobj()       { return reinterpret_cast<GtkIconView*>(gobject_); }
 
  const GtkIconView* gobj() const { return reinterpret_cast<GtkIconView*>(gobject_); }
 
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
  virtual void on_set_scroll_adjustments(Adjustment* hadjustment, Adjustment* vadjustment);
  virtual void on_item_activated(const TreeModel::Path& path);
  virtual void on_selection_changed();
 
 
private:
 
public:
 
  IconView();
    explicit IconView(const Glib::RefPtr<TreeModel>& model);
 
 
  void set_model(const Glib::RefPtr<TreeModel>& model);
  
  Glib::RefPtr<TreeModel> get_model();
  
  Glib::RefPtr<const TreeModel> get_model() const;
 
  void unset_model();
 
  
  void set_text_column(int column);
  
  void set_text_column(const TreeModelColumnBase& model_column);
  
  int get_text_column() const;
  
  void set_markup_column(int column);
  
  void set_markup_column(const TreeModelColumnBase& column);
  
  int get_markup_column() const;
  
  void set_pixbuf_column(int column);
  
  void set_pixbuf_column(const TreeModelColumnBase& column);
  
  int get_pixbuf_column() const;
 
  
  void set_orientation(Orientation orientation);
  
  Orientation get_orientation() const;
 
  
  void set_item_orientation(Orientation orientation);
  
  Orientation get_item_orientation() const;
 
  
  void set_columns(int columns);
  
  int get_columns() const;
  
  void set_item_width(int item_width);
  
  int get_icon_width() const;
  
  void set_spacing(int spacing);
  
  int get_spacing() const;
  
  void set_row_spacing(int row_spacing);
  
  gint get_row_spacing() const;
  
  void set_column_spacing(int column_spacing);
  
  int get_column_spacing() const;
 
  
  void set_margin(int margin);
  
  int get_margin() const;
 
  
  TreeModel::Path get_path_at_pos(int x, int y) const;
 
 
  bool get_item_at_pos(int x, int y, TreeModel::Path& path, CellRenderer*& cell) const;
 
  bool get_item_at_pos(int x, int y, TreeModel::Path& path) const;
 
  bool get_item_at_pos(int x, int y, CellRenderer*& cell) const;
  
 
  bool get_visible_range(TreeModel::Path& start_path, TreeModel::Path& end_path) const;
  
 
  typedef sigc::slot<void, const TreeModel::Path&> SlotForeach;
 
  void selected_foreach(const SlotForeach& slot);
  
 
//Default value?:
  
  void set_selection_mode(SelectionMode mode);
  
  SelectionMode get_selection_mode() const;
  
  void select_path(const TreeModel::Path& path);
  
  void unselect_path(const TreeModel::Path& path);
  
  bool path_is_selected(const TreeModel::Path& path) const;
 
 
  #ifndef DOXYGEN_SHOULD_SKIP_THIS
  //TODO: I'm not sure about these to_*() functions. murrayc.
  struct TreePathTraits
  {
    typedef TreePath  CppType;
    typedef const GtkTreePath* CType;
    typedef GtkTreePath*    CTypeNonConst;
 
    static CType   to_c_type      (const CppType& obj) { return obj.gobj(); }
    static CType   to_c_type      (const CType&   obj) { return obj; }
    static CppType to_cpp_type    (const CType&   obj) { return CppType(const_cast<CTypeNonConst>(obj), true); }
    static void    release_c_type (const CType&)       {}
  };
  #endif //DOXYGEN_SHOULD_SKIP_THIS
 
  typedef Glib::ListHandle<TreePath, TreePathTraits> ArrayHandle_TreePaths;
 
  
  ArrayHandle_TreePaths get_selected_items() const;
 
  
  void select_all();
  
  void unselect_all();
  
  void item_activated(const TreeModel::Path& path);
 
  //TODO: Add a version with no cell parameter.
  
  void set_cursor(const TreeModel::Path& path, CellRenderer& cell, bool start_editing);
 
  bool get_cursor(TreeModel::Path& path, CellRenderer*& cell) const;
 
  bool get_cursor(TreeModel::Path& path) const;
 
  bool get_cursor(CellRenderer*& cell) const;
  
 
  void scroll_to_path(const TreeModel::Path& path, bool use_align, gfloat row_align, gfloat col_align);
 
/* Drag-and-Drop support */
  void enable_model_drag_source(const ArrayHandle_TargetEntry& targets,
                                Gdk::ModifierType start_button_mask = Gdk::MODIFIER_MASK,
                                Gdk::DragAction actions = Gdk::ACTION_COPY | Gdk::ACTION_MOVE);
  
 
  void enable_model_drag_dest(const ArrayHandle_TargetEntry& targets, Gdk::DragAction actions = Gdk::ACTION_COPY | Gdk::ACTION_MOVE);
  
 
  void unset_model_drag_source();
  
  void unset_model_drag_dest();
 
  
  void set_reorderable(bool reorderable =  true);
  
  bool get_reorderable() const;
 
 
/* These are useful to implement your own custom stuff. */
  //TODO: Discover what arguments are output arguments:
  
  void set_drag_dest_item(const TreeModel::Path& path, IconViewDropPosition pos);
 
  void get_drag_dest_item(TreeModel::Path& path, IconViewDropPosition& pos) const;
 
  void get_drag_dest_item(TreeModel::Path& path) const;
 
  void get_drag_dest_item(IconViewDropPosition& pos) const;
  
 
  bool get_dest_item_at_pos(int drag_x, int drag_y, TreeModel::Path& path, IconViewDropPosition& pos) const;
 
  bool get_dest_item_at_pos(int drag_x, int drag_y, TreeModel::Path& path) const;
 
  bool get_dest_item_at_pos(int drag_x, int drag_y, IconViewDropPosition& pos) const;
  
 
  Glib::RefPtr<Gdk::Pixmap> create_drag_icon(const TreeModel::Path& path);
 
  
  void convert_widget_to_bin_window_coords(int wx, int wy, int& bx, int& by) const;
 
  
  void set_tooltip_item(const Glib::RefPtr<Tooltip>& tooltip, const TreeModel::Path& path);
  
  void set_tooltip_cell(const Glib::RefPtr<Tooltip>& tooltip, const TreeModel::Path& path, CellRenderer& cell);
 
  void set_tooltip_cell(const Glib::RefPtr<Tooltip>& tooltip, const TreeModel::Path& path);
 
  
  bool get_tooltip_context_path(int& x, int& y,
                                bool keyboard_tip,
                                TreeModel::Path& path);
 
  bool get_tooltip_context_iter(int& x, int& y,
                                bool keyboard_tip,
                                Gtk::TreeModel::iterator& iter);
 
  
  void set_tooltip_column(int column);
  
  int get_tooltip_column() const;
 
 
  Glib::SignalProxy2< void,Adjustment*,Adjustment* > signal_set_scroll_adjustments();
 
  
  Glib::SignalProxy1< void,const TreeModel::Path& > signal_item_activated();
 
  
  Glib::SignalProxy0< void > signal_selection_changed();
 
 
  /* Key binding signals */
  
  
  Glib::PropertyProxy< int > property_pixbuf_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_pixbuf_column() const;
 
  Glib::PropertyProxy< int > property_text_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_text_column() const;
 
  Glib::PropertyProxy< int > property_markup_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_markup_column() const;
 
  Glib::PropertyProxy< int > property_tooltip_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_tooltip_column() const;
 
  Glib::PropertyProxy< SelectionMode > property_selection_mode() ;
 
  Glib::PropertyProxy_ReadOnly< SelectionMode > property_selection_mode() const;
 
  Glib::PropertyProxy< Orientation > property_orientation() ;
 
  Glib::PropertyProxy_ReadOnly< Orientation > property_orientation() const;
 //deprecated
  Glib::PropertyProxy< Orientation > property_item_orientation() ;
 
  Glib::PropertyProxy_ReadOnly< Orientation > property_item_orientation() const;
 
  Glib::PropertyProxy< bool > property_reorderable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_reorderable() const;
 
  Glib::PropertyProxy< Glib::RefPtr<TreeModel> > property_model() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TreeModel> > property_model() const;
 
  Glib::PropertyProxy< int > property_columns() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_columns() const;
 
  Glib::PropertyProxy< int > property_item_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_item_width() const;
 
  Glib::PropertyProxy< int > property_spacing() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_spacing() const;
 
  Glib::PropertyProxy< int > property_row_spacing() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_row_spacing() const;
 
  Glib::PropertyProxy< int > property_column_spacing() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_column_spacing() const;
 
  Glib::PropertyProxy< int > property_margin() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_margin() const;
 
  Glib::PropertyProxy< int > property_item_padding() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_item_padding() const;
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::IconView* wrap(GtkIconView* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_ICONVIEW_H */