13
0
livetrax/libs/gtkmm2/gtk/gtkmm/comboboxtext.h
Paul Davis 449aab3c46 rollback to 3428, before the mysterious removal of libs/* at 3431/3432
git-svn-id: svn://localhost/ardour2/branches/3.0@3435 d708f5d6-7413-0410-9779-e7cbd77b26cf
2008-06-02 21:41:35 +00:00

118 lines
3.4 KiB
C++

// -*- 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 Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library 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.
/** This is a specialisation of the ComboBox which has one column of text (a simple list),
* and appropriate methods for setting and getting the text.
*
* Note that you can not use this class with Gnome::Glade::Xml::get_widget_derived() to wrap a GtkComboBox added
* in the Glade user interface designer, because Glade adds its own TreeModel instead of using the TreeModel from
* this class. You could use a normal Gtk::ComboBox instead, though you can not use Glade to add rows to a TreeModel
* that is defined in your C++ code.
*
* @ingroup Widgets
*/
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();
/** Add an item to the end of the drop-down list.
* @param text The text for the item.
*/
void append_text(const Glib::ustring& text);
void insert_text(int position, const Glib::ustring& text);
/** Add an item to the beginning of the drop-down list.
* @param text The text for the item.
*/
void prepend_text(const Glib::ustring& text);
/** Get the currently-chosen item.
* @result The text of the active item.
*/
Glib::ustring get_active_text() const;
/** Set the currently-chosen item if it matches the specified text.
* @text The text of the item that should be selected.
*/
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.
/// @deprecated See clear_items(). Since 2.8.
void clear();
/** Remove all items from the drop-down menu.
*/
void clear_items();
/** Remove the specified item if it is in the drop-down menu.
* @text The text of the item that should be removed.
*/
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 */