/usr/include/gtkmm-2.4/gtkmm/treemodelsort.h is in libgtkmm-2.4-dev 1:2.24.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | // -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_TREEMODELSORT_H
#define _GTKMM_TREEMODELSORT_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* $Id: treemodelsort.hg,v 1.5 2006/04/12 11:11:25 murrayc Exp $ */
/* 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 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.
*/
// We couldn't include it in treemodel.h, but doing it here makes it easier for people.
#include <gtkmm/treepath.h>
#include <gtkmm/treeiter.h>
#include <gtkmm/treemodel.h>
#include <gtkmm/treesortable.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkTreeModelSort GtkTreeModelSort;
typedef struct _GtkTreeModelSortClass GtkTreeModelSortClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class TreeModelSort_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
/** A wrapper which makes an underlying Gtk::TreeModel sortable.
*
* The TreeModelSort is a model which implements the TreeSortable interface.
* It does not hold any data itself, but rather is created with
* a child model and proxies its data. It has identical column types to
* this child model, and the changes in the child are propagated. The
* primary purpose of this model is to provide a way to sort a different
* model without modifying it. Note that the sort function used by
* TreeModelSort is not guaranteed to be stable.
*
* For instance, you might create two TreeView widgets each with a
* view of the same data. If the model is wrapped by a
* TreeModelSort then the two TreeViews can each sort their
* view of the data without affecting the other. By contrast, if we
* simply put the same model in each widget, then sorting the first would
* sort the second.
*
* @ingroup TreeView
*/
class TreeModelSort : public Glib::Object, public TreeModel, public TreeSortable
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef TreeModelSort CppObjectType;
typedef TreeModelSort_Class CppClassType;
typedef GtkTreeModelSort BaseObjectType;
typedef GtkTreeModelSortClass BaseClassType;
private: friend class TreeModelSort_Class;
static CppClassType treemodelsort_class_;
private:
// noncopyable
TreeModelSort(const TreeModelSort&);
TreeModelSort& operator=(const TreeModelSort&);
protected:
explicit TreeModelSort(const Glib::ConstructParams& construct_params);
explicit TreeModelSort(GtkTreeModelSort* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~TreeModelSort();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkTreeModelSort* gobj() { return reinterpret_cast<GtkTreeModelSort*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkTreeModelSort* gobj() const { return reinterpret_cast<GtkTreeModelSort*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkTreeModelSort* gobj_copy();
private:
protected:
explicit TreeModelSort(const Glib::RefPtr<TreeModel>& model);
public:
static Glib::RefPtr<TreeModelSort> create(const Glib::RefPtr<TreeModel>& model);
/** Returns the model the Gtk::TreeModelSort is sorting.
*
* @return The "child model" being sorted.
*/
Glib::RefPtr<TreeModel> get_model();
/** Returns the model the Gtk::TreeModelSort is sorting.
*
* @return The "child model" being sorted.
*/
Glib::RefPtr<const TreeModel> get_model() const;
/** Converts @a child_path to a path relative to @a tree_model_sort. That is,
* @a child_path points to a path in the child model. The returned path will
* point to the same row in the sorted model. If @a child_path isn't a valid
* path on the child model, then <tt>0</tt> is returned.
*
* @param child_path A Gtk::TreePath to convert.
* @return A newly allocated Gtk::TreePath, or <tt>0</tt>.
*/
Path convert_child_path_to_path(const Path& child_path) const;
/** Gets an iterator that points to the sorted row that corresponds to the child row pointed at by child_iter.
*
* @param child_iter A valid iterator pointing to a row on the child model.
* @result A valid iterator that points to the row in this sorted model.
*/
iterator convert_child_iter_to_iter(const iterator& child_iter) const;
/** Converts @a sorted_path to a path on the child model of @a tree_model_sort.
* That is, @a sorted_path points to a location in @a tree_model_sort. The
* returned path will point to the same location in the model not being
* sorted. If @a sorted_path does not point to a location in the child model,
* <tt>0</tt> is returned.
*
* @param sorted_path A Gtk::TreePath to convert.
* @return A newly allocated Gtk::TreePath, or <tt>0</tt>.
*/
Path convert_path_to_child_path(const Path& sorted_path) const;
/** Gets an iterator that points to the child row that corresponds to the sorted row pointed at by sorted_iter.
*
* @param sorted_iter A valid iterator pointing to a row on the sorted model.
* @result A valid iterator that points to the row in the child model.
*/
iterator convert_iter_to_child_iter(const iterator& sorted_iter) const;
/** This resets the default sort function to be in the 'unsorted' state. That
* is, it is in the same order as the child model. It will re-sort the model
* to be in the same order as the child model only if the Gtk::TreeModelSort
* is in 'unsorted' state.
*/
void reset_default_sort_func();
/** This function should almost never be called. It clears the @a tree_model_sort
* of any cached iterators that haven't been reffed with
* ref_node(). This might be useful if the child model being
* sorted is static (and doesn't change often) and there has been a lot of
* unreffed access to nodes. As a side effect of this function, all unreffed
* iters will be invalid.
*/
void clear_cache();
/** <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::TreeModelSort.
*
* @newin{2,2}
*
* @param iter A Gtk::TreeIter.
* @return <tt>true</tt> if the iter is valid, <tt>false</tt> if the iter is invalid.
*/
bool iter_is_valid(const iterator& iter) const;
/** The model for the TreeModelSort to sort.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<TreeModel> > property_model() 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
{
/** A Glib::wrap() method for this object.
*
* @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.
*
* @relates Gtk::TreeModelSort
*/
Glib::RefPtr<Gtk::TreeModelSort> wrap(GtkTreeModelSort* object, bool take_copy = false);
}
#endif /* _GTKMM_TREEMODELSORT_H */
|