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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  21 #error "Only <gtk/gtk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __GTK_TREE_SELECTION_H__
  25 #define __GTK_TREE_SELECTION_H__
  26
  27 #include <gtk/gtktreeview.h>
  28
  29 G_BEGIN_DECLS
  30
  31
  32 #define GTK_TYPE_TREE_SELECTION                 (gtk_tree_selection_get_type ())
  33 #define GTK_TREE_SELECTION(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelection))
  34 #define GTK_TREE_SELECTION_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  35 #define GTK_IS_TREE_SELECTION(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SELECTION))
  36 #define GTK_IS_TREE_SELECTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_SELECTION))
  37 #define GTK_TREE_SELECTION_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  38
  39 typedef struct _GtkTreeSelectionPrivate      GtkTreeSelectionPrivate;
  40
  41 /**
  42  * GtkTreeSelectionFunc:
  43  * @selection: A #GtkTreeSelection
  44  * @model: A #GtkTreeModel being viewed
  45  * @path: The #GtkTreePath of the row in question
  46  * @path_currently_selected: %TRUE, if the path is currently selected
  47  * @data: (closure): user data
  48  *
  49  * A function used by gtk_tree_selection_set_select_function() to filter
  50  * whether or not a row may be selected.  It is called whenever a row's
  51  * state might change.  A return value of %TRUE indicates to @selection
  52  * that it is okay to change the selection.
  53  *
  54  * Returns: %TRUE, if the selection state of the row can be toggled
  55  */
  56 typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
  57                                               GtkTreeModel      *model,
  58                                               GtkTreePath       *path,
  59                                               gboolean           path_currently_selected,
  60                                               gpointer           data);
  61
  62 /**
  63  * GtkTreeSelectionForeachFunc:
  64  * @model: The #GtkTreeModel being viewed
  65  * @path: The #GtkTreePath of a selected row
  66  * @iter: A #GtkTreeIter pointing to a selected row
  67  * @data: (closure): user data
  68  *
  69  * A function used by gtk_tree_selection_selected_foreach() to map all
  70  * selected rows.  It will be called on every selected row in the view.
  71  */
  72 typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel      *model,
  73                                               GtkTreePath       *path,
  74                                               GtkTreeIter       *iter,
  75                                               gpointer           data);
  76
  77 struct _GtkTreeSelection
  78 {
  79   /*< private >*/
  80   GObject parent;
  81
  82   GtkTreeSelectionPrivate *priv;
  83 };
  84
  85 struct _GtkTreeSelectionClass
  86 {
  87   GObjectClass parent_class;
  88
  89   void (* changed) (GtkTreeSelection *selection);
  90
  91   /* Padding for future expansion */
  92   void (*_gtk_reserved1) (void);
  93   void (*_gtk_reserved2) (void);
  94   void (*_gtk_reserved3) (void);
  95   void (*_gtk_reserved4) (void);
  96 };
  97
  98
  99 GType            gtk_tree_selection_get_type            (void) G_GNUC_CONST;
 100
 101 void             gtk_tree_selection_set_mode            (GtkTreeSelection            *selection,
 102                                                          GtkSelectionMode             type);
 103 GtkSelectionMode gtk_tree_selection_get_mode        (GtkTreeSelection            *selection);
 104 void             gtk_tree_selection_set_select_function (GtkTreeSelection            *selection,
 105                                                          GtkTreeSelectionFunc         func,
 106                                                          gpointer                     data,
 107                                                          GDestroyNotify               destroy);
 108 gpointer         gtk_tree_selection_get_user_data       (GtkTreeSelection            *selection);
 109 GtkTreeView*     gtk_tree_selection_get_tree_view       (GtkTreeSelection            *selection);
 110
 111 GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection        *selection);
 112
 113 /* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
 114 /* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
 115 gboolean         gtk_tree_selection_get_selected        (GtkTreeSelection            *selection,
 116                                                          GtkTreeModel               **model,
 117                                                          GtkTreeIter                 *iter);
 118 GList *          gtk_tree_selection_get_selected_rows   (GtkTreeSelection            *selection,
 119                                                          GtkTreeModel               **model);
 120 gint             gtk_tree_selection_count_selected_rows (GtkTreeSelection            *selection);
 121 void             gtk_tree_selection_selected_foreach    (GtkTreeSelection            *selection,
 122                                                          GtkTreeSelectionForeachFunc  func,
 123                                                          gpointer                     data);
 124 void             gtk_tree_selection_select_path         (GtkTreeSelection            *selection,
 125                                                          GtkTreePath                 *path);
 126 void             gtk_tree_selection_unselect_path       (GtkTreeSelection            *selection,
 127                                                          GtkTreePath                 *path);
 128 void             gtk_tree_selection_select_iter         (GtkTreeSelection            *selection,
 129                                                          GtkTreeIter                 *iter);
 130 void             gtk_tree_selection_unselect_iter       (GtkTreeSelection            *selection,
 131                                                          GtkTreeIter                 *iter);
 132 gboolean         gtk_tree_selection_path_is_selected    (GtkTreeSelection            *selection,
 133                                                          GtkTreePath                 *path);
 134 gboolean         gtk_tree_selection_iter_is_selected    (GtkTreeSelection            *selection,
 135                                                          GtkTreeIter                 *iter);
 136 void             gtk_tree_selection_select_all          (GtkTreeSelection            *selection);
 137 void             gtk_tree_selection_unselect_all        (GtkTreeSelection            *selection);
 138 void             gtk_tree_selection_select_range        (GtkTreeSelection            *selection,
 139                                                          GtkTreePath                 *start_path,
 140                                                          GtkTreePath                 *end_path);
 141 void             gtk_tree_selection_unselect_range      (GtkTreeSelection            *selection,
 142                                                          GtkTreePath                 *start_path,
 143                                                          GtkTreePath                 *end_path);
 144
 145
 146 G_END_DECLS
 147
 148 #endif /* __GTK_TREE_SELECTION_H__ */