comboboxtext.h

Go to the documentation of this file.

// -*- c++ -*-
#ifndef _GTKMM_COMBOBOXTEXT_H
#define _GTKMM_COMBOBOXTEXT_H
 
/* comboboxtext.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/combobox.h>
 
namespace Gtk
{
 
//This is a C++ convenience class that is equivalent to the gtk_combo_box_new_text() C convenience function.
//In gtkmm-3.0 we simply wrap GtkComboBoxText, which is also in GTK+ 2.24.
//But this C++ class was created before GtkComboBoxText existed and we want to avoid changing the ABI. 
 
class ComboBoxText
: public ComboBox
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
  // noncopyable
  ComboBoxText(const ComboBoxText&);
  ComboBoxText& operator=(const ComboBoxText&);
 
protected:
  explicit ComboBoxText(const Glib::ConstructParams& construct_params);
  explicit ComboBoxText(GtkComboBox* castitem);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
 
  ComboBoxText();
  
  explicit ComboBoxText(bool has_entry); //In gtkmm 3.0 has_entry has a default value but we already have a default constructor here.
 
  void append(const Glib::ustring& text);
  
  void insert(int position, const Glib::ustring& text);
 
  void prepend(const Glib::ustring& text);
  
#ifndef GTKMM_DISABLE_DEPRECATED
  void append_text(const Glib::ustring& text);
  
  void insert_text(int position, const Glib::ustring& text);
 
  void prepend_text(const Glib::ustring& text);
  
  void clear_items();
#endif //GTKMM_DISABLE_DEPRECATED
 
  Glib::ustring get_active_text() const;
 
  void set_active_text(const Glib::ustring& text);
 
  //There is a clear() method in the CellLayout base class, so this would cause confusion.
  //TODO: Remove this when we can break API.
  void clear();
 
  void remove_all();
  
  void remove_text(const Glib::ustring& text);
 
protected:
 
  //Tree model columns:
  //These columns are used by the model that is created by the default constructor
  class TextModelColumns : public Gtk::TreeModel::ColumnRecord
  {
  public:
    TextModelColumns()
    { add(m_column); }
 
    Gtk::TreeModelColumn<Glib::ustring> m_column;
  };
 
  TextModelColumns m_text_columns;
};
 
 
} // namespace Gtk
 
 
#endif /* _GTKMM_COMBOBOXTEXT_H */