diff options
Diffstat (limited to 'libs/gtkmm2/gtk/gtkmm/liststore.h')
| -rw-r--r-- | libs/gtkmm2/gtk/gtkmm/liststore.h | 246 |
1 files changed, 246 insertions, 0 deletions
diff --git a/libs/gtkmm2/gtk/gtkmm/liststore.h b/libs/gtkmm2/gtk/gtkmm/liststore.h new file mode 100644 index 0000000000..9d2fe355e2 --- /dev/null +++ b/libs/gtkmm2/gtk/gtkmm/liststore.h @@ -0,0 +1,246 @@ +// -*- c++ -*- +// Generated by gtkmmproc -- DO NOT MODIFY! +#ifndef _GTKMM_LISTSTORE_H +#define _GTKMM_LISTSTORE_H + +#include <glibmm.h> + +/* $Id$ */ + +/* Copyright(C) 1998-2002 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/treeiter.h> +#include <gtkmm/treemodel.h> +#include <gtkmm/treesortable.h> +#include <gtkmm/treedragdest.h> +#include <gtkmm/treedragsource.h> +// We couldn't include it in treemodel.h, but doing it here makes it easier for people. +#include <gtkmm/treepath.h> + + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +typedef struct _GtkListStore GtkListStore; +typedef struct _GtkListStoreClass GtkListStoreClass; +#endif /* DOXYGEN_SHOULD_SKIP_THIS */ + + +namespace Gtk +{ class ListStore_Class; } // namespace Gtk +namespace Gtk +{ + +/** Thist is a list model for use with a Gtk::TreeView widget. + * @ingroup TreeView + * It implements the Gtk::TreeModel interface, and also implements the + * Gtk::TreeSortable interface so you can sort the list using the view. + * Finally, it also implements the tree drag and drop interfaces. + */ + +class ListStore : + public Glib::Object, + public TreeModel, + public TreeSortable, + public TreeDragSource, + public TreeDragDest +{ + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + +public: + typedef ListStore CppObjectType; + typedef ListStore_Class CppClassType; + typedef GtkListStore BaseObjectType; + typedef GtkListStoreClass BaseClassType; + +private: friend class ListStore_Class; + static CppClassType liststore_class_; + +private: + // noncopyable + ListStore(const ListStore&); + ListStore& operator=(const ListStore&); + +protected: + explicit ListStore(const Glib::ConstructParams& construct_params); + explicit ListStore(GtkListStore* castitem); + +#endif /* DOXYGEN_SHOULD_SKIP_THIS */ + +public: + virtual ~ListStore(); + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + static GType get_type() G_GNUC_CONST; + static GType get_base_type() G_GNUC_CONST; +#endif + + ///Provides access to the underlying C GObject. + GtkListStore* gobj() { return reinterpret_cast<GtkListStore*>(gobject_); } + + ///Provides access to the underlying C GObject. + const GtkListStore* gobj() const { return reinterpret_cast<GtkListStore*>(gobject_); } + + ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. + GtkListStore* gobj_copy(); + +private: + + +protected: + /** When using this constructor, you must use set_column_types() immediately afterwards. + * This can be useful when deriving from this class, with a fixed TreeModelColumnRecord + * that is a member of the class. + * There is no create() method that corresponds to this constructor, because this + * constructor should only be used by derived classes. + */ + ListStore(); + + explicit ListStore(const TreeModelColumnRecord& columns); + +public: + + /** Instantiate a new ListStore. + * @param columns The column types for this tree model. + * @result The new ListStore. + */ + + static Glib::RefPtr<ListStore> create(const TreeModelColumnRecord& columns); + + + void set_column_types(const TreeModelColumnRecord& columns); + + + /** Removes the given row from the list store. + * @param iter The iterator to the row to be removed. + * @result An iterator to the next row, or end() if there is none. + */ + iterator erase(const iterator& iter); + + + //TODO: Make this documentation similar to documentation for Standard C++ insert methods. + /** Creates a new row before the position. + * If iter is end() then a new row will be appended to the list. + * The row will be empty - to fill in values, you need to dereference the returned iterator and use Row::operator[] or Row::set_value(). + * See also prepend() and append(). + * + * @param iter An iterator to the row before which the new row will be inserted. + * @result An iterator to the new row. + */ + iterator insert(const iterator& iter); + + + //TODO: Docs. This one is apparently faster. + /** Creates a new row after the position. + * If iter is end() then a new row will be prepended to the list. + * The row will be empty - to fill in values, you need to dereference the returned iterator and use Row::operator[] or Row::set_value(). + * See also insert(), prepend() and append(). + * + * @param iter An iterator to the row after which the new row will be inserted. + * @result An iterator to the new row. + */ + iterator insert_after(const iterator& iter); + + + /** Creates a new row at the start. + * The row will be empty - to fill in values, you need to dereference the returned iterator and use Row::operator[] or Row::set_value(). + * See also insert() and append(). + * + * @result An iterator to the new row. + */ + iterator prepend(); + + /** Creates a new row at the end. + * The row will be empty - to fill in values, you need to dereference the returned iterator and use Row::operator[] or Row::set_value(). + * See also insert() and prepend(). + * + * @result An iterator to the new row. + */ + iterator append(); + + + /** Swaps @a a and @a b in @a store . Note that this function only works with + * unsorted stores. + * + * Since: 2.2 + * @param a A Gtk::TreeIter. + * @param b Another Gtk::TreeIter. + */ + void iter_swap(const iterator& a, const iterator& b); + + /** Moves @a source to the position at @a destination. + * Note that this function only works with unsorted stores. + * @param source The row that should be moved. + * @param destination The position to move to. + */ + void move(const iterator& source, const iterator& destination); + + /** Reorders the list store to follow the order indicated by @a new_order. + * Note that this function only works with unsorted stores. + */ + void reorder(const Glib::ArrayHandle<int>& new_order); + + + /** Removes all rows from the list store. + */ + void clear(); + + + /** <warning>This function is slow. Only use it for debugging and/or testing + * purposes.</warning> + * + * Checks if the given iter is a valid iter for this Gtk::ListStore. + * @param iter A Gtk::TreeIter. + * @return <tt>true</tt> if the iter is valid, <tt>false</tt> if the iter is invalid. + * + * Since: 2.2. + */ + bool iter_is_valid(const iterator& iter) const; + +protected: + virtual void set_value_impl(const iterator& row, int column, const Glib::ValueBase& value); + + +public: + +public: + //C++ methods used to invoke GTK+ virtual functions: + +protected: + //GTK+ Virtual Functions (override these to change behaviour): + + //Default Signal Handlers:: + + +}; + +} // namespace Gtk + + +namespace Glib +{ + /** @relates Gtk::ListStore + * @param object The C instance + * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. + * @result A C++ instance that wraps this C instance. + */ + Glib::RefPtr<Gtk::ListStore> wrap(GtkListStore* object, bool take_copy = false); +} + + +#endif /* _GTKMM_LISTSTORE_H */ + |