combobox.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_COMBOBOX_H
#define _GTKMM_COMBOBOX_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* $Id: combobox.hg,v 1.17 2006/09/19 20:08:42 murrayc Exp $ */
 
/* combobox.h
 * 
 * Copyright (C) 2003 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/bin.h>
#include <gtkmm/celllayout.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/cellrenderer.h>
#include <gtkmm/treeview.h>
#include <gtkmm/enums.h> //For SensitivityType.
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkComboBox GtkComboBox;
typedef struct _GtkComboBoxClass GtkComboBoxClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{ class ComboBox_Class; } // namespace Gtk
namespace Gtk
{
 
class ComboBox
: public Bin,
  public CellLayout
//TODO: Since GTK+ 2.6, this should now inherit also from CellEditable, but we can't add this base without breaking ABI.
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef ComboBox CppObjectType;
  typedef ComboBox_Class CppClassType;
  typedef GtkComboBox BaseObjectType;
  typedef GtkComboBoxClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
  virtual ~ComboBox();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
private:
  friend class ComboBox_Class;
  static CppClassType combobox_class_;
 
  // noncopyable
  ComboBox(const ComboBox&);
  ComboBox& operator=(const ComboBox&);
 
protected:
  explicit ComboBox(const Glib::ConstructParams& construct_params);
  explicit ComboBox(GtkComboBox* 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
 
  GtkComboBox*       gobj()       { return reinterpret_cast<GtkComboBox*>(gobject_); }
 
  const GtkComboBox* gobj() const { return reinterpret_cast<GtkComboBox*>(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_changed();
 
 
private:
 
  
public:
  ComboBox();
  
    explicit ComboBox(const Glib::RefPtr<TreeModel>& model);
 
   //See ComboBoxText for an equivalent of gtk_combo_box_new_text().
 
  explicit ComboBox(bool has_entry); //has_entry has a default value in gtkmm-3.0 but can't here because we already have a default constructor.
  
  explicit ComboBox(const Glib::RefPtr<TreeModel>& model, bool has_entry); //has_entry has a default value in gtkmm-3.0 but can't here because we already have a default constructor.
  
  
  void set_wrap_width(int width);
  
  int get_wrap_width() const;
 
  
  void set_row_span_column(int row_span);
  
  int get_row_span_column() const;
 
  
  void set_column_span_column(int column_span);
  
  int get_column_span_column() const;
 
  
  bool get_add_tearoffs() const;
  
  void set_add_tearoffs(bool add_tearoffs =  true);
 
  
  Glib::ustring get_title() const;
  
  void set_title(const Glib::ustring& title);
 
  
  bool get_focus_on_click() const;
  
  void set_focus_on_click(bool focus_on_click =  true);
 
/* get/set active item */
  
  int get_active_row_number() const;
 
  TreeModel::iterator get_active();
  
  TreeModel::const_iterator get_active() const;
  
    
  void set_active(int index);
  
  void set_active(const TreeModel::iterator& iter);
  
  //TODO: See https://bugzilla.gnome.org/show_bug.cgi?id=612396#c30
  Glib::ustring get_entry_text() const;
 
  void unset_active();
 
  
  Glib::RefPtr<TreeModel> get_model();
  
  Glib::RefPtr<const TreeModel> get_model() const;
  
  void set_model(const Glib::RefPtr<TreeModel>& model);
 
  void unset_model();
 
  typedef TreeView::SlotRowSeparator SlotRowSeparator;  
  
  void set_row_separator_func(const SlotRowSeparator& slot);
  
  void unset_row_separator_func();
  
 
  void set_button_sensitivity(SensitivityType sensitivity);
  
  SensitivityType get_button_sensitivity() const;
 
  
  bool get_has_entry() const;
 
  
  void set_entry_text_column(const TreeModelColumnBase& text_column) const;
  
  void set_entry_text_column(int text_column);
 
  
  int get_entry_text_column() const;
 
  
  void popup();
  
  void popdown();
 
  
#ifdef  GTKMM_ATKMM_ENABLED
 
  Glib::RefPtr<Atk::Object> get_popup_accessible();
#endif //  GTKMM_ATKMM_ENABLED
 
  
#ifdef  GTKMM_ATKMM_ENABLED
 
  Glib::RefPtr<const Atk::Object> get_popup_accessible() const;
#endif //  GTKMM_ATKMM_ENABLED
 
 
   //These are in ComboBoxText.
 
  Entry* get_entry();
 
  const Entry* get_entry() const;
  
  Glib::PropertyProxy< Glib::RefPtr<TreeModel> > property_model() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TreeModel> > property_model() const;
 
  Glib::PropertyProxy< int > property_wrap_width() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_wrap_width() const;
 
  Glib::PropertyProxy< int > property_row_span_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_row_span_column() const;
 
  Glib::PropertyProxy< int > property_column_span_column() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_column_span_column() const;
 
  Glib::PropertyProxy< int > property_active() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_active() const;
 
  Glib::PropertyProxy< bool > property_add_tearoffs() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_add_tearoffs() const;
 
  Glib::PropertyProxy< bool > property_has_frame() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_has_frame() const;
 
  Glib::PropertyProxy< bool > property_focus_on_click() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_focus_on_click() const;
 
  Glib::PropertyProxy< Glib::ustring > property_tearoff_title() ;
 
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tearoff_title() const;
 
  Glib::PropertyProxy_ReadOnly< bool > property_popup_shown() const;
 
 
  Glib::PropertyProxy< SensitivityType > property_button_sensitivity() ;
 
  Glib::PropertyProxy_ReadOnly< SensitivityType > property_button_sensitivity() const;
 
 
  Glib::SignalProxy0< void > signal_changed();
 
 
  //Key-binding signals:
  
    
};
 
 
} // namespace Gtk
 
 
namespace Glib
{
  Gtk::ComboBox* wrap(GtkComboBox* object, bool take_copy = false);
} //namespace Glib
 
 
#endif /* _GTKMM_COMBOBOX_H */