treeviewcolumn.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREEVIEWCOLUMN_H
#define _GTKMM_TREEVIEWCOLUMN_H
 
#include <ytkmm/ytkmmconfig.h>
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* Copyright(C) 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 <ytkmm/object.h>
#include <ytkmm/widget.h>
#include <ydkmm/window.h>
#include <ytkmm/treeiter.h>
#include <ytkmm/treemodel.h>
#include <glibmm/listhandle.h>
#include <ytkmm/cellrenderer_generation.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class TreeViewColumn_Class; } // namespace Gtk
namespace Gtk
{
 
 
enum TreeViewColumnSizing
{
  TREE_VIEW_COLUMN_GROW_ONLY,
  TREE_VIEW_COLUMN_AUTOSIZE,
  TREE_VIEW_COLUMN_FIXED
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::TreeViewColumnSizing> : public Glib::Value_Enum<Gtk::TreeViewColumnSizing>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
// We use GTKMM_API here because gcc needs the extra help on win32 , even
// when using --export-all and auto-import.
// See http://bugzilla.gnome.org/show_bug.cgi?id=309030.
 
//TODO: This should derive+implement from CellLayout when we can break ABI.
 
class TreeView;
 
class GTKMM_API TreeViewColumn : public Gtk::Object
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef TreeViewColumn CppObjectType;
  typedef TreeViewColumn_Class CppClassType;
  typedef GtkTreeViewColumn BaseObjectType;
  typedef GtkTreeViewColumnClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~TreeViewColumn();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class TreeViewColumn_Class;
  static CppClassType treeviewcolumn_class_;
 
  // noncopyable
  TreeViewColumn(const TreeViewColumn&);
  TreeViewColumn& operator=(const TreeViewColumn&);
 
protected:
  explicit TreeViewColumn(const Glib::ConstructParams& construct_params);
  explicit TreeViewColumn(GtkTreeViewColumn* 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
 
  GtkTreeViewColumn*       gobj()       { return reinterpret_cast<GtkTreeViewColumn*>(gobject_); }
 
  const GtkTreeViewColumn* gobj() const { return reinterpret_cast<GtkTreeViewColumn*>(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_clicked();
 
 
private:
 
  
public:
  typedef TreeViewColumn Column;
 
  TreeViewColumn();
 
  explicit TreeViewColumn(const Glib::ustring& title);
  TreeViewColumn(const Glib::ustring& title, CellRenderer& cell);
 
  template<class T_ModelColumnType>
  TreeViewColumn(const Glib::ustring& title, const TreeModelColumn<T_ModelColumnType>& column);
 
  
  void pack_start(CellRenderer& cell, bool expand =  true);
  
  void pack_end(CellRenderer& cell, bool expand =  true);
 
  template<class T_ModelColumnType>
  void pack_start(const TreeModelColumn<T_ModelColumnType>& column, bool expand = true);
 
  template<class T_ModelColumnType>
  void pack_end(const TreeModelColumn<T_ModelColumnType>& column, bool expand = true);
 
  
  void clear();
 
  //We replaced get_first_cell() with get_first_cell() because that
  //is the name of the method in CellLayout, which this class derives from in gtkmm-3.0.
  //That allows more code to be ported before actually using gtkmm-3.0.
 
  CellRenderer* get_first_cell();
 
  const CellRenderer* get_first_cell() const;
 
  #ifndef GTKMM_DISABLE_DEPRECATED
 
  CellRenderer* get_first_cell_renderer();
 
  const CellRenderer* get_first_cell_renderer() const;
  #endif // GTKMM_DISABLE_DEPRECATED
 
 
  // TODO: Should be deprecated, but we cannot derive from CellLayout
  // without breaking API and ABI.
  
  Glib::ListHandle<CellRenderer*> get_cell_renderers();
  
  Glib::ListHandle<const CellRenderer*> get_cell_renderers() const;
 
  
  void add_attribute(CellRenderer& cell_renderer, const Glib::ustring& attribute, int column);
 
  void add_attribute(const Glib::PropertyProxy_Base& property, const TreeModelColumnBase& column);
 
  void add_attribute(Gtk::CellRenderer& cell, const Glib::ustring& property_name, const TreeModelColumnBase& column);
  
 
  void set_renderer(Gtk::CellRenderer& renderer, const TreeModelColumnBase& column);
 
 // _WRAP_METHOD(void set_attributes(CellRenderer& cell_renderer, ...), )
 
  typedef sigc::slot<void, CellRenderer*, const Gtk::TreeModel::iterator&> SlotCellData;
 
  void set_cell_data_func(CellRenderer& cell_renderer, const SlotCellData& slot);
 
  void unset_cell_data_func(CellRenderer& cell_renderer);
 
  
  void clear_attributes(CellRenderer& cell_renderer);
  
  void set_spacing(int spacing);
  
  int get_spacing() const;
  
  void set_visible(bool visible =  true);
  
  bool get_visible() const;
  
  void set_resizable(bool resizable =  true);
  
  bool get_resizable() const;
  
  void set_sizing(TreeViewColumnSizing type);
  
  TreeViewColumnSizing get_sizing();
  
  int get_width() const;
  
  int get_fixed_width() const;
  
  void set_fixed_width(int fixed_width);
  
  void set_min_width(int min_width);
  
  int get_min_width() const;
  
  void set_max_width(int max_width);
  
  int get_max_width() const;
  
  void clicked();
 
  
  void set_title(const Glib::ustring& title);
  
  Glib::ustring get_title() const;
 
  
  void set_expand(bool expand =  true);
  
  bool get_expand() const;
 
  
  void set_clickable(bool clickable =  true);
  
  bool get_clickable() const;
  
  void set_widget(Gtk::Widget& widget);
  
  Widget* get_widget();
  
  const Widget* get_widget() const;
 
  
  void set_alignment(float xalign);
  
  void set_alignment(AlignmentEnum xalign);
 
  
  float get_alignment() const;
  
  void set_reorderable(bool reorderable =  true);
  
  bool get_reorderable() const;
 
  
  void set_sort_column(const TreeModelColumnBase& sort_column_id);
  
  void set_sort_column(int sort_column_id);
 
  #ifndef GTKMM_DISABLE_DEPRECATED
 
  void set_sort_column_id(const TreeModelColumnBase& sort_column_id);
 
  void set_sort_column_id(int sort_column_id);
  #endif // GTKMM_DISABLE_DEPRECATED
 
 
  int get_sort_column_id() const;
  
  void set_sort_indicator(bool setting);
  
  bool get_sort_indicator() const;
  
  void set_sort_order(SortType order);
  
  SortType get_sort_order() const;
 
 
  void cell_set_cell_data(const Glib::RefPtr<TreeModel>& tree_model, const TreeModel::iterator& iter, bool is_expander, bool is_expanded);
 
  //This is obviously a bad cast, but we need it to preserve this (wrong) deprecated version of this function:
   
 
#ifndef GTKMM_DISABLE_DEPRECATED
 
  void cell_get_size(Gdk::Rectangle& cell_area, int& x_offset, int& y_offset, int& width, int& height) const;
#endif // GTKMM_DISABLE_DEPRECATED
 
 
  //TODO: cell_area can be NULL. Add a method override.
  //But see http://bugzilla.gnome.org/show_bug.cgi?id=542329 about the lack of C documentation.
  
  void cell_get_size(const Gdk::Rectangle& cell_area, int& x_offset, int& y_offset, int& width, int& height) const;
 
  
  bool cell_is_visible() const;
  
  void focus_cell(CellRenderer& cell);
 
  
  bool get_cell_position(const CellRenderer& cell_renderer, int& start_pos, int& width) const;
  
  void queue_resize();
 
  
  TreeView* get_tree_view();
  
  const TreeView* get_tree_view() const;
 
  
  Glib::SignalProxy0< void > signal_clicked();
 
 
  Glib::PropertyProxy< bool > property_visible() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_visible() const;
 
  Glib::PropertyProxy< bool > property_resizable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_resizable() const;
 
  Glib::PropertyProxy_ReadOnly< int > property_width() const;
 
 
  Glib::PropertyProxy< int > property_spacing() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_spacing() const;
 
  Glib::PropertyProxy< TreeViewColumnSizing > property_sizing() ;
 
  Glib::PropertyProxy_ReadOnly< TreeViewColumnSizing > property_sizing() const;
 
  Glib::PropertyProxy< int > property_fixed_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_fixed_width() const;
 
  Glib::PropertyProxy< int > property_min_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_min_width() const;
 
  Glib::PropertyProxy< int > property_max_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_max_width() const;
 
  Glib::PropertyProxy< Glib::ustring > property_title() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title() const;
 
  Glib::PropertyProxy< bool > property_expand() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_expand() const;
 
  Glib::PropertyProxy< bool > property_clickable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_clickable() const;
 
  Glib::PropertyProxy< Widget* > property_widget() ;
 
  Glib::PropertyProxy_ReadOnly< Widget* > property_widget() const;
 
  Glib::PropertyProxy< float > property_alignment() ;
 
  Glib::PropertyProxy_ReadOnly< float > property_alignment() const;
 
  Glib::PropertyProxy< bool > property_reorderable() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_reorderable() const;
 
  Glib::PropertyProxy< bool > property_sort_indicator() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_sort_indicator() const;
 
  Glib::PropertyProxy< SortType > property_sort_order() ;
 
  Glib::PropertyProxy_ReadOnly< SortType > property_sort_order() const;
 
  Glib::PropertyProxy< int > property_sort_column_id() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_sort_column_id() const;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
  // Only necessary because of the templated ctor, see below.
  static const Glib::Class& class_init_();
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
 
};
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
template<class T_ModelColumnType> inline
void TreeViewColumn::pack_start(const TreeModelColumn<T_ModelColumnType>& column, bool expand)
{
  //Generate appropriate Renderer for the column:
  CellRenderer* pCellRenderer = manage( CellRenderer_Generation::generate_cellrenderer<T_ModelColumnType>() );
 
  //Use the renderer:
  pack_start(*pCellRenderer, expand);
  set_renderer(*pCellRenderer, column);
}
 
template<class T_ModelColumnType> inline
void TreeViewColumn::pack_end(const TreeModelColumn<T_ModelColumnType>& column, bool expand)
{
  //Generate appropriate Renderer for the column:
  CellRenderer* pCellRenderer= manage( CellRenderer_Generation::generate_cellrenderer<T_ModelColumnType>() );
 
  //Use the renderer:
  pack_end(*pCellRenderer, expand);
  set_renderer(*pCellRenderer, column);
}
 
template <class T_ModelColumnType> inline
TreeViewColumn::TreeViewColumn(const Glib::ustring& title,
                               const TreeModelColumn<T_ModelColumnType>& column)
:
  Glib::ObjectBase(0), // not (yet) a custom class
  Gtk::Object(Glib::ConstructParams(class_init_(), "title", title.c_str(), (char*) 0))
{
  pack_start(column, true /* expand */);
}
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::TreeViewColumn* wrap(GtkTreeViewColumn* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_TREEVIEWCOLUMN_H */