Pileus Git - ~andy/gtk/blob - gtk/gtktreeselection.h

   1 /* gtktreeselection.h
   2  * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GTK_TREE_SELECTION_H__
  19 #define __GTK_TREE_SELECTION_H__
  20
  21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  22 #error "Only <gtk/gtk.h> can be included directly."
  23 #endif
  24
  25 #include <gtk/gtktreeview.h>
  26
  27 G_BEGIN_DECLS
  28
  29
  30 #define GTK_TYPE_TREE_SELECTION                 (gtk_tree_selection_get_type ())
  31 #define GTK_TREE_SELECTION(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelection))
  32 #define GTK_TREE_SELECTION_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  33 #define GTK_IS_TREE_SELECTION(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SELECTION))
  34 #define GTK_IS_TREE_SELECTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_SELECTION))
  35 #define GTK_TREE_SELECTION_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  36
  37 typedef struct _GtkTreeSelectionPrivate      GtkTreeSelectionPrivate;
  38
  39 /**
  40  * GtkTreeSelectionFunc:
  41  * @selection: A #GtkTreeSelection
  42  * @model: A #GtkTreeModel being viewed
  43  * @path: The #GtkTreePath of the row in question
  44  * @path_currently_selected: %TRUE, if the path is currently selected
  45  * @data: (closure): user data
  46  *
  47  * A function used by gtk_tree_selection_set_select_function() to filter
  48  * whether or not a row may be selected.  It is called whenever a row's
  49  * state might change.  A return value of %TRUE indicates to @selection
  50  * that it is okay to change the selection.
  51  *
  52  * Returns: %TRUE, if the selection state of the row can be toggled
  53  */
  54 typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
  55                                               GtkTreeModel      *model,
  56                                               GtkTreePath       *path,
  57                                               gboolean           path_currently_selected,
  58                                               gpointer           data);
  59
  60 /**
  61  * GtkTreeSelectionForeachFunc:
  62  * @model: The #GtkTreeModel being viewed
  63  * @path: The #GtkTreePath of a selected row
  64  * @iter: A #GtkTreeIter pointing to a selected row
  65  * @data: (closure): user data
  66  *
  67  * A function used by gtk_tree_selection_selected_foreach() to map all
  68  * selected rows.  It will be called on every selected row in the view.
  69  */
  70 typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel      *model,
  71                                               GtkTreePath       *path,
  72                                               GtkTreeIter       *iter,
  73                                               gpointer           data);
  74
  75 struct _GtkTreeSelection
  76 {
  77   /*< private >*/
  78   GObject parent;
  79
  80   GtkTreeSelectionPrivate *priv;
  81 };
  82
  83 struct _GtkTreeSelectionClass
  84 {
  85   GObjectClass parent_class;
  86
  87   void (* changed) (GtkTreeSelection *selection);
  88
  89   /* Padding for future expansion */
  90   void (*_gtk_reserved1) (void);
  91   void (*_gtk_reserved2) (void);
  92   void (*_gtk_reserved3) (void);
  93   void (*_gtk_reserved4) (void);
  94 };
  95
  96
  97 GType            gtk_tree_selection_get_type            (void) G_GNUC_CONST;
  98
  99 void             gtk_tree_selection_set_mode            (GtkTreeSelection            *selection,
 100                                                          GtkSelectionMode             type);
 101 GtkSelectionMode gtk_tree_selection_get_mode        (GtkTreeSelection            *selection);
 102 void             gtk_tree_selection_set_select_function (GtkTreeSelection            *selection,
 103                                                          GtkTreeSelectionFunc         func,
 104                                                          gpointer                     data,
 105                                                          GDestroyNotify               destroy);
 106 gpointer         gtk_tree_selection_get_user_data       (GtkTreeSelection            *selection);
 107 GtkTreeView*     gtk_tree_selection_get_tree_view       (GtkTreeSelection            *selection);
 108
 109 GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection        *selection);
 110
 111 /* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
 112 /* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
 113 gboolean         gtk_tree_selection_get_selected        (GtkTreeSelection            *selection,
 114                                                          GtkTreeModel               **model,
 115                                                          GtkTreeIter                 *iter);
 116 GList *          gtk_tree_selection_get_selected_rows   (GtkTreeSelection            *selection,
 117                                                          GtkTreeModel               **model);
 118 gint             gtk_tree_selection_count_selected_rows (GtkTreeSelection            *selection);
 119 void             gtk_tree_selection_selected_foreach    (GtkTreeSelection            *selection,
 120                                                          GtkTreeSelectionForeachFunc  func,
 121                                                          gpointer                     data);
 122 void             gtk_tree_selection_select_path         (GtkTreeSelection            *selection,
 123                                                          GtkTreePath                 *path);
 124 void             gtk_tree_selection_unselect_path       (GtkTreeSelection            *selection,
 125                                                          GtkTreePath                 *path);
 126 void             gtk_tree_selection_select_iter         (GtkTreeSelection            *selection,
 127                                                          GtkTreeIter                 *iter);
 128 void             gtk_tree_selection_unselect_iter       (GtkTreeSelection            *selection,
 129                                                          GtkTreeIter                 *iter);
 130 gboolean         gtk_tree_selection_path_is_selected    (GtkTreeSelection            *selection,
 131                                                          GtkTreePath                 *path);
 132 gboolean         gtk_tree_selection_iter_is_selected    (GtkTreeSelection            *selection,
 133                                                          GtkTreeIter                 *iter);
 134 void             gtk_tree_selection_select_all          (GtkTreeSelection            *selection);
 135 void             gtk_tree_selection_unselect_all        (GtkTreeSelection            *selection);
 136 void             gtk_tree_selection_select_range        (GtkTreeSelection            *selection,
 137                                                          GtkTreePath                 *start_path,
 138                                                          GtkTreePath                 *end_path);
 139 void             gtk_tree_selection_unselect_range      (GtkTreeSelection            *selection,
 140                                                          GtkTreePath                 *start_path,
 141                                                          GtkTreePath                 *end_path);
 142
 143
 144 G_END_DECLS
 145
 146 #endif /* __GTK_TREE_SELECTION_H__ */