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_DISABLE_SINGLE_INCLUDES) && !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 <glib-object.h>
  28 #include <gtk/gtktreeview.h>
  29
  30
  31 G_BEGIN_DECLS
  32
  33
  34 #define GTK_TYPE_TREE_SELECTION                 (gtk_tree_selection_get_type ())
  35 #define GTK_TREE_SELECTION(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelection))
  36 #define GTK_TREE_SELECTION_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  37 #define GTK_IS_TREE_SELECTION(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_SELECTION))
  38 #define GTK_IS_TREE_SELECTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_SELECTION))
  39 #define GTK_TREE_SELECTION_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_SELECTION, GtkTreeSelectionClass))
  40
  41 typedef gboolean (* GtkTreeSelectionFunc)    (GtkTreeSelection  *selection,
  42                                               GtkTreeModel      *model,
  43                                               GtkTreePath       *path,
  44                                               gboolean           path_currently_selected,
  45                                               gpointer           data);
  46 typedef void (* GtkTreeSelectionForeachFunc) (GtkTreeModel      *model,
  47                                               GtkTreePath       *path,
  48                                               GtkTreeIter       *iter,
  49                                               gpointer           data);
  50
  51 struct _GtkTreeSelection
  52 {
  53   GObject parent;
  54
  55   /*< private >*/
  56
  57   GtkTreeView *GSEAL (tree_view);
  58   GtkSelectionMode GSEAL (type);
  59   GtkTreeSelectionFunc GSEAL (user_func);
  60   gpointer GSEAL (user_data);
  61   GDestroyNotify GSEAL (destroy);
  62 };
  63
  64 struct _GtkTreeSelectionClass
  65 {
  66   GObjectClass parent_class;
  67
  68   void (* changed) (GtkTreeSelection *selection);
  69
  70   /* Padding for future expansion */
  71   void (*_gtk_reserved1) (void);
  72   void (*_gtk_reserved2) (void);
  73   void (*_gtk_reserved3) (void);
  74   void (*_gtk_reserved4) (void);
  75 };
  76
  77
  78 GType            gtk_tree_selection_get_type            (void) G_GNUC_CONST;
  79
  80 void             gtk_tree_selection_set_mode            (GtkTreeSelection            *selection,
  81                                                          GtkSelectionMode             type);
  82 GtkSelectionMode gtk_tree_selection_get_mode        (GtkTreeSelection            *selection);
  83 void             gtk_tree_selection_set_select_function (GtkTreeSelection            *selection,
  84                                                          GtkTreeSelectionFunc         func,
  85                                                          gpointer                     data,
  86                                                          GDestroyNotify               destroy);
  87 gpointer         gtk_tree_selection_get_user_data       (GtkTreeSelection            *selection);
  88 GtkTreeView*     gtk_tree_selection_get_tree_view       (GtkTreeSelection            *selection);
  89
  90 GtkTreeSelectionFunc gtk_tree_selection_get_select_function (GtkTreeSelection        *selection);
  91
  92 /* Only meaningful if GTK_SELECTION_SINGLE or GTK_SELECTION_BROWSE is set */
  93 /* Use selected_foreach or get_selected_rows for GTK_SELECTION_MULTIPLE */
  94 gboolean         gtk_tree_selection_get_selected        (GtkTreeSelection            *selection,
  95                                                          GtkTreeModel               **model,
  96                                                          GtkTreeIter                 *iter);
  97 GList *          gtk_tree_selection_get_selected_rows   (GtkTreeSelection            *selection,
  98                                                          GtkTreeModel               **model);
  99 gint             gtk_tree_selection_count_selected_rows (GtkTreeSelection            *selection);
 100 void             gtk_tree_selection_selected_foreach    (GtkTreeSelection            *selection,
 101                                                          GtkTreeSelectionForeachFunc  func,
 102                                                          gpointer                     data);
 103 void             gtk_tree_selection_select_path         (GtkTreeSelection            *selection,
 104                                                          GtkTreePath                 *path);
 105 void             gtk_tree_selection_unselect_path       (GtkTreeSelection            *selection,
 106                                                          GtkTreePath                 *path);
 107 void             gtk_tree_selection_select_iter         (GtkTreeSelection            *selection,
 108                                                          GtkTreeIter                 *iter);
 109 void             gtk_tree_selection_unselect_iter       (GtkTreeSelection            *selection,
 110                                                          GtkTreeIter                 *iter);
 111 gboolean         gtk_tree_selection_path_is_selected    (GtkTreeSelection            *selection,
 112                                                          GtkTreePath                 *path);
 113 gboolean         gtk_tree_selection_iter_is_selected    (GtkTreeSelection            *selection,
 114                                                          GtkTreeIter                 *iter);
 115 void             gtk_tree_selection_select_all          (GtkTreeSelection            *selection);
 116 void             gtk_tree_selection_unselect_all        (GtkTreeSelection            *selection);
 117 void             gtk_tree_selection_select_range        (GtkTreeSelection            *selection,
 118                                                          GtkTreePath                 *start_path,
 119                                                          GtkTreePath                 *end_path);
 120 void             gtk_tree_selection_unselect_range      (GtkTreeSelection            *selection,
 121                                                          GtkTreePath                 *start_path,
 122                                                          GtkTreePath                 *end_path);
 123
 124
 125 G_END_DECLS
 126
 127
 128 #endif /* __GTK_TREE_SELECTION_H__ */