2000-10-05 01:04:57 +00:00
|
|
|
/* gtktreemodel.h
|
|
|
|
|
* Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
|
|
|
|
|
*
|
|
|
|
|
* 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., 59 Temple Place - Suite 330,
|
|
|
|
|
* Boston, MA 02111-1307, USA.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __GTK_TREE_MODEL_H__
|
|
|
|
|
#define __GTK_TREE_MODEL_H__
|
|
|
|
|
|
|
|
|
|
#include <gtk/gtkobject.h>
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
|
|
|
|
#define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
|
2000-10-16 23:11:55 +00:00
|
|
|
#define GTK_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
|
|
|
|
|
#define GTK_IS_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
|
|
|
|
|
#define GTK_TREE_MODEL_GET_IFACE(obj) ((GtkTreeModelIface *)g_type_interface_peek (((GTypeInstance *)GTK_TREE_MODEL (obj))->g_class, GTK_TYPE_TREE_MODEL))
|
2000-10-05 01:04:57 +00:00
|
|
|
|
2001-01-27 00:50:38 +00:00
|
|
|
typedef struct _GtkTreeIter GtkTreeIter;
|
|
|
|
|
typedef struct _GtkTreePath GtkTreePath;
|
|
|
|
|
typedef struct _GtkTreeRowReference GtkTreeRowReference;
|
|
|
|
|
typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
|
|
|
|
|
typedef struct _GtkTreeModelIface GtkTreeModelIface;
|
2000-10-05 01:04:57 +00:00
|
|
|
|
2000-11-09 16:52:17 +00:00
|
|
|
|
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0
|
|
|
|
|
} GtkTreeModelFlags;
|
|
|
|
|
|
2000-10-26 00:36:47 +00:00
|
|
|
struct _GtkTreeIter
|
|
|
|
|
{
|
|
|
|
|
gint stamp;
|
2001-01-04 23:36:19 +00:00
|
|
|
gpointer user_data;
|
|
|
|
|
gpointer user_data2;
|
|
|
|
|
gpointer user_data3;
|
2000-10-26 00:36:47 +00:00
|
|
|
};
|
|
|
|
|
|
2000-10-16 23:11:55 +00:00
|
|
|
struct _GtkTreeModelIface
|
2000-10-05 01:04:57 +00:00
|
|
|
{
|
2000-10-16 23:11:55 +00:00
|
|
|
GTypeInterface g_iface;
|
2000-10-05 01:04:57 +00:00
|
|
|
|
2000-10-16 23:11:55 +00:00
|
|
|
/* Signals */
|
2000-10-26 00:36:47 +00:00
|
|
|
void (* changed) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void (* inserted) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
2001-03-05 19:43:24 +00:00
|
|
|
void (* has_child_toggled) (GtkTreeModel *tree_model,
|
2000-10-26 00:36:47 +00:00
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void (* deleted) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path);
|
2000-12-21 05:27:06 +00:00
|
|
|
void (* reordered) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
gint *new_order);
|
2000-10-05 01:04:57 +00:00
|
|
|
|
2001-02-21 19:59:23 +00:00
|
|
|
/* Virtual Table */
|
Adapt to GtkTreeSelection changes
2001-01-01 Havoc Pennington <hp@redhat.com>
* gtk/gtktreeview.c: Adapt to GtkTreeSelection changes
* gtk/gtktreeselection.c (_gtk_tree_selection_set_tree_view):
don't fill in tree_view->priv->selection, kind of an unexpected
side effect
* gtk/gtkcellrenderertext.c: Remove definition of _ and include
gtkintl.h
* gtk/gtkcellrenderer.c: Remove definition of _ and include
gtkintl.h
(gtk_cell_renderer_get_property): remove calls to g_value_init
* gtk/gtkcellrendererpixbuf.c: Remove definition of _ and include
gtkintl.h
* gtk/gtkcellrenderertextpixbuf.c: Remove definition of _ macro
and include gtkintl.h
(gtk_cell_renderer_text_pixbuf_class_init): remove spaces from
property names
* gtk/gtktreeselection.c (_gtk_tree_selection_new): rename, return
GtkTreeSelection
(_gtk_tree_selection_new_from_with_view): rename, return
GtkTreeSelection
(_gtk_tree_selection_set_tree_view): rename with uscore
(gtk_tree_selection_get_selected): fill in the "model" out param
first, so it gets filled in even if we return at the top of the
function
(gtk_tree_selection_real_select_all): add a comment and an else{}
to clarify this a bit
(gtk_tree_selection_real_unselect_all): add the same else{}
* gtk/gtktreeselection.h: Rename new, new_with_tree_view, and
set_tree_view to have underscore prefixes, move them to the
private header, fix return type of new_with_tree_view
(struct _GtkTreeSelection): mark struct
fields private
* gtk/gtktreemodel.c (gtk_tree_model_get_flags): return
GtkTreeModelFlags, not a guint
(gtk_tree_path_prev): return gboolean not gint
(gtk_tree_path_up): return gboolean not gint
* gtk/gtktreemodel.h (struct _GtkTreeModelIface): make get_flags
return GtkTreeModelFlags, not a guint
* gtk/gtktreemodelsort.c (gtk_tree_model_sort_finalize): check
that child model is non-null before unrefing it
(g_value_int_compare_func): make this a qsort compare func, not
a boolean predicate
* gtk/gtktreemodelsort.h: rename gtk_tree_model_set_sort_column,
(add -umn to the end), and mark it unimplemented
(gtk_tree_model_sort_resort): remove, this wasn't implemented, and
I don't see what it's for - doesn't the model always sort itself?
(gtk_tree_model_sort_set_compare): this had the wrong signature
* gtk/gtktreeviewcolumn.c (gtk_tree_view_column_set_attributes):
Fix the docs to say that it destructively replaces existing
attributes (previously said that it added attributes).
(gtk_tree_view_column_set_visible): canonicalize bool before
equality testing. Also, check for realization before
hiding/showing the tree_column->window; if this window could exist
before realization, then it's busted and needs fixing, we can't
create GDK resources pre-realization. Also, remove
superfluous queue_resize(), since set_size() does that for us.
(gtk_tree_view_column_set_col_type): check realization before
using tree_column->window
* gtk/gtktreedatalist.c: fix filename in copyright notice
2001-01-01 19:01:54 +00:00
|
|
|
GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
|
|
|
|
|
|
2000-10-05 01:04:57 +00:00
|
|
|
gint (* get_n_columns) (GtkTreeModel *tree_model);
|
2000-10-26 00:36:47 +00:00
|
|
|
GType (* get_column_type) (GtkTreeModel *tree_model,
|
|
|
|
|
gint index);
|
|
|
|
|
gboolean (* get_iter) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
2000-10-05 01:04:57 +00:00
|
|
|
GtkTreePath *path);
|
|
|
|
|
GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
|
2000-10-26 00:36:47 +00:00
|
|
|
GtkTreeIter *iter);
|
2000-10-27 23:34:58 +00:00
|
|
|
void (* get_value) (GtkTreeModel *tree_model,
|
2000-10-26 00:36:47 +00:00
|
|
|
GtkTreeIter *iter,
|
2000-10-05 01:04:57 +00:00
|
|
|
gint column,
|
|
|
|
|
GValue *value);
|
2000-10-26 00:36:47 +00:00
|
|
|
gboolean (* iter_next) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gboolean (* iter_children) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
2000-10-27 23:34:58 +00:00
|
|
|
GtkTreeIter *parent);
|
2000-10-26 00:36:47 +00:00
|
|
|
gboolean (* iter_has_child) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gint (* iter_n_children) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
GtkTreeIter *parent,
|
2000-10-05 01:04:57 +00:00
|
|
|
gint n);
|
2000-10-26 00:36:47 +00:00
|
|
|
gboolean (* iter_parent) (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
2000-10-27 23:34:58 +00:00
|
|
|
GtkTreeIter *child);
|
2001-03-09 00:19:11 +00:00
|
|
|
void (* ref_node) (GtkTreeModel *tree_model,
|
2000-11-09 16:52:17 +00:00
|
|
|
GtkTreeIter *iter);
|
2001-03-09 00:19:11 +00:00
|
|
|
void (* unref_node) (GtkTreeModel *tree_model,
|
2000-11-09 16:52:17 +00:00
|
|
|
GtkTreeIter *iter);
|
2000-10-05 01:04:57 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2000-11-09 16:52:17 +00:00
|
|
|
/* GtkTreePath operations */
|
2000-10-26 00:36:47 +00:00
|
|
|
GtkTreePath *gtk_tree_path_new (void);
|
|
|
|
|
GtkTreePath *gtk_tree_path_new_from_string (gchar *path);
|
|
|
|
|
gchar *gtk_tree_path_to_string (GtkTreePath *path);
|
|
|
|
|
GtkTreePath *gtk_tree_path_new_root (void);
|
|
|
|
|
void gtk_tree_path_append_index (GtkTreePath *path,
|
|
|
|
|
gint index);
|
|
|
|
|
void gtk_tree_path_prepend_index (GtkTreePath *path,
|
|
|
|
|
gint index);
|
|
|
|
|
gint gtk_tree_path_get_depth (GtkTreePath *path);
|
|
|
|
|
gint *gtk_tree_path_get_indices (GtkTreePath *path);
|
|
|
|
|
void gtk_tree_path_free (GtkTreePath *path);
|
|
|
|
|
GtkTreePath *gtk_tree_path_copy (GtkTreePath *path);
|
|
|
|
|
gint gtk_tree_path_compare (const GtkTreePath *a,
|
|
|
|
|
const GtkTreePath *b);
|
|
|
|
|
void gtk_tree_path_next (GtkTreePath *path);
|
Adapt to GtkTreeSelection changes
2001-01-01 Havoc Pennington <hp@redhat.com>
* gtk/gtktreeview.c: Adapt to GtkTreeSelection changes
* gtk/gtktreeselection.c (_gtk_tree_selection_set_tree_view):
don't fill in tree_view->priv->selection, kind of an unexpected
side effect
* gtk/gtkcellrenderertext.c: Remove definition of _ and include
gtkintl.h
* gtk/gtkcellrenderer.c: Remove definition of _ and include
gtkintl.h
(gtk_cell_renderer_get_property): remove calls to g_value_init
* gtk/gtkcellrendererpixbuf.c: Remove definition of _ and include
gtkintl.h
* gtk/gtkcellrenderertextpixbuf.c: Remove definition of _ macro
and include gtkintl.h
(gtk_cell_renderer_text_pixbuf_class_init): remove spaces from
property names
* gtk/gtktreeselection.c (_gtk_tree_selection_new): rename, return
GtkTreeSelection
(_gtk_tree_selection_new_from_with_view): rename, return
GtkTreeSelection
(_gtk_tree_selection_set_tree_view): rename with uscore
(gtk_tree_selection_get_selected): fill in the "model" out param
first, so it gets filled in even if we return at the top of the
function
(gtk_tree_selection_real_select_all): add a comment and an else{}
to clarify this a bit
(gtk_tree_selection_real_unselect_all): add the same else{}
* gtk/gtktreeselection.h: Rename new, new_with_tree_view, and
set_tree_view to have underscore prefixes, move them to the
private header, fix return type of new_with_tree_view
(struct _GtkTreeSelection): mark struct
fields private
* gtk/gtktreemodel.c (gtk_tree_model_get_flags): return
GtkTreeModelFlags, not a guint
(gtk_tree_path_prev): return gboolean not gint
(gtk_tree_path_up): return gboolean not gint
* gtk/gtktreemodel.h (struct _GtkTreeModelIface): make get_flags
return GtkTreeModelFlags, not a guint
* gtk/gtktreemodelsort.c (gtk_tree_model_sort_finalize): check
that child model is non-null before unrefing it
(g_value_int_compare_func): make this a qsort compare func, not
a boolean predicate
* gtk/gtktreemodelsort.h: rename gtk_tree_model_set_sort_column,
(add -umn to the end), and mark it unimplemented
(gtk_tree_model_sort_resort): remove, this wasn't implemented, and
I don't see what it's for - doesn't the model always sort itself?
(gtk_tree_model_sort_set_compare): this had the wrong signature
* gtk/gtktreeviewcolumn.c (gtk_tree_view_column_set_attributes):
Fix the docs to say that it destructively replaces existing
attributes (previously said that it added attributes).
(gtk_tree_view_column_set_visible): canonicalize bool before
equality testing. Also, check for realization before
hiding/showing the tree_column->window; if this window could exist
before realization, then it's busted and needs fixing, we can't
create GDK resources pre-realization. Also, remove
superfluous queue_resize(), since set_size() does that for us.
(gtk_tree_view_column_set_col_type): check realization before
using tree_column->window
* gtk/gtktreedatalist.c: fix filename in copyright notice
2001-01-01 19:01:54 +00:00
|
|
|
gboolean gtk_tree_path_prev (GtkTreePath *path);
|
|
|
|
|
gboolean gtk_tree_path_up (GtkTreePath *path);
|
2000-10-26 00:36:47 +00:00
|
|
|
void gtk_tree_path_down (GtkTreePath *path);
|
|
|
|
|
|
2001-01-31 00:57:49 +00:00
|
|
|
gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
|
|
|
|
|
GtkTreePath *descendant);
|
|
|
|
|
gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
|
|
|
|
|
GtkTreePath *ancestor);
|
|
|
|
|
|
2001-02-28 21:37:50 +00:00
|
|
|
/* Row reference (an object that tracks model changes so it refers to the same
|
|
|
|
|
* row always; a path refers to a position, not a fixed row). You almost always
|
|
|
|
|
* want to call gtk_tree_row_reference_new.
|
2001-01-27 00:50:38 +00:00
|
|
|
*/
|
|
|
|
|
|
2001-02-28 21:37:50 +00:00
|
|
|
GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
|
|
|
|
|
GtkTreePath *path);
|
|
|
|
|
GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
|
|
|
|
|
GtkTreeModel *model,
|
|
|
|
|
GtkTreePath *path);
|
|
|
|
|
GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
|
|
|
|
|
void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
|
|
|
|
|
|
|
|
|
|
/* These two functions are only needed if you created the row reference with a
|
|
|
|
|
* proxy object */
|
|
|
|
|
void gtk_tree_row_reference_inserted (GObject *proxy,
|
|
|
|
|
GtkTreePath *path);
|
|
|
|
|
void gtk_tree_row_reference_deleted (GObject *proxy,
|
|
|
|
|
GtkTreePath *path);
|
|
|
|
|
|
2000-11-09 16:52:17 +00:00
|
|
|
/* GtkTreeIter operations */
|
2001-02-28 21:37:50 +00:00
|
|
|
GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_iter_free (GtkTreeIter *iter);
|
2000-11-09 16:52:17 +00:00
|
|
|
|
2001-02-28 21:37:50 +00:00
|
|
|
GtkType gtk_tree_model_get_type (void) G_GNUC_CONST;
|
|
|
|
|
GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
|
|
|
|
|
gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
|
|
|
|
|
GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
|
|
|
|
|
gint index);
|
2000-10-26 00:36:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/* Iterator movement */
|
2001-02-28 21:37:50 +00:00
|
|
|
gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
GtkTreePath *path);
|
|
|
|
|
gboolean gtk_tree_model_get_first (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_model_get_value (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
gint column,
|
|
|
|
|
GValue *value);
|
|
|
|
|
gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
GtkTreeIter *parent);
|
|
|
|
|
gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
GtkTreeIter *parent,
|
|
|
|
|
gint n);
|
|
|
|
|
gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
GtkTreeIter *child);
|
2001-03-09 00:19:11 +00:00
|
|
|
void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
|
2001-02-28 21:37:50 +00:00
|
|
|
GtkTreeIter *iter);
|
2001-03-09 00:19:11 +00:00
|
|
|
void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
|
2001-02-28 21:37:50 +00:00
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_model_get (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
...);
|
|
|
|
|
void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreeIter *iter,
|
|
|
|
|
va_list var_args);
|
|
|
|
|
|
2001-02-17 00:16:08 +00:00
|
|
|
|
2001-02-22 01:56:08 +00:00
|
|
|
/* Signals */
|
2001-03-05 19:43:24 +00:00
|
|
|
void gtk_tree_model_changed (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_model_inserted (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_model_has_child_toggled (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
GtkTreeIter *iter);
|
|
|
|
|
void gtk_tree_model_deleted (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path);
|
2001-03-23 00:35:19 +00:00
|
|
|
void gtk_tree_model_reordered (GtkTreeModel *tree_model,
|
|
|
|
|
GtkTreePath *path,
|
|
|
|
|
gint *new_order);
|
2001-03-05 19:43:24 +00:00
|
|
|
|
2001-02-17 00:16:08 +00:00
|
|
|
|
2000-10-05 01:04:57 +00:00
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif /* __GTK_TREE_MODEL_H__ */
|
