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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef __GTK_WIDGET_PATH_H__
  19 #define __GTK_WIDGET_PATH_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 <glib-object.h>
  26 #include <gdk/gdk.h>
  27 #include <gtk/gtkenums.h>
  28 #include <gtk/gtktypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define GTK_TYPE_WIDGET_PATH (gtk_widget_path_get_type ())
  33
  34 GType           gtk_widget_path_get_type            (void) G_GNUC_CONST;
  35 GtkWidgetPath * gtk_widget_path_new                 (void);
  36
  37 GtkWidgetPath * gtk_widget_path_copy                (const GtkWidgetPath *path);
  38 GDK_AVAILABLE_IN_3_2
  39 GtkWidgetPath * gtk_widget_path_ref                 (GtkWidgetPath       *path);
  40 GDK_AVAILABLE_IN_3_2
  41 void            gtk_widget_path_unref               (GtkWidgetPath       *path);
  42 void            gtk_widget_path_free                (GtkWidgetPath       *path);
  43
  44 GDK_AVAILABLE_IN_3_2
  45 char *          gtk_widget_path_to_string           (const GtkWidgetPath *path);
  46 gint            gtk_widget_path_length              (const GtkWidgetPath *path);
  47
  48 gint            gtk_widget_path_append_type         (GtkWidgetPath       *path,
  49                                                      GType                type);
  50 void            gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
  51                                                      GType                type);
  52 GDK_AVAILABLE_IN_3_2
  53 gint            gtk_widget_path_append_with_siblings(GtkWidgetPath       *path,
  54                                                      GtkWidgetPath       *siblings,
  55                                                      guint                sibling_index);
  56 /* gtk_widget_path_append_for_widget() is declared in gtkwidget.c */
  57 GDK_AVAILABLE_IN_3_2
  58 gint            gtk_widget_path_append_for_widget   (GtkWidgetPath       *path,
  59                                                      GtkWidget           *widget);
  60
  61 GType               gtk_widget_path_iter_get_object_type  (const GtkWidgetPath *path,
  62                                                            gint                 pos);
  63 void                gtk_widget_path_iter_set_object_type  (GtkWidgetPath       *path,
  64                                                            gint                 pos,
  65                                                            GType                type);
  66 const GtkWidgetPath *
  67                     gtk_widget_path_iter_get_siblings     (const GtkWidgetPath *path,
  68                                                            gint                 pos);
  69 guint               gtk_widget_path_iter_get_sibling_index(const GtkWidgetPath *path,
  70                                                            gint                 pos);
  71
  72 const gchar *          gtk_widget_path_iter_get_name  (const GtkWidgetPath *path,
  73                                                        gint                 pos);
  74 void                   gtk_widget_path_iter_set_name  (GtkWidgetPath       *path,
  75                                                        gint                 pos,
  76                                                        const gchar         *name);
  77 gboolean               gtk_widget_path_iter_has_name  (const GtkWidgetPath *path,
  78                                                        gint                 pos,
  79                                                        const gchar         *name);
  80 gboolean               gtk_widget_path_iter_has_qname (const GtkWidgetPath *path,
  81                                                        gint                 pos,
  82                                                        GQuark               qname);
  83
  84 void     gtk_widget_path_iter_add_class     (GtkWidgetPath       *path,
  85                                              gint                 pos,
  86                                              const gchar         *name);
  87 void     gtk_widget_path_iter_remove_class  (GtkWidgetPath       *path,
  88                                              gint                 pos,
  89                                              const gchar         *name);
  90 void     gtk_widget_path_iter_clear_classes (GtkWidgetPath       *path,
  91                                              gint                 pos);
  92 GSList * gtk_widget_path_iter_list_classes  (const GtkWidgetPath *path,
  93                                              gint                 pos);
  94 gboolean gtk_widget_path_iter_has_class     (const GtkWidgetPath *path,
  95                                              gint                 pos,
  96                                              const gchar         *name);
  97 gboolean gtk_widget_path_iter_has_qclass    (const GtkWidgetPath *path,
  98                                              gint                 pos,
  99                                              GQuark               qname);
 100
 101 void     gtk_widget_path_iter_add_region    (GtkWidgetPath      *path,
 102                                              gint                pos,
 103                                              const gchar        *name,
 104                                              GtkRegionFlags     flags);
 105 void     gtk_widget_path_iter_remove_region (GtkWidgetPath      *path,
 106                                              gint                pos,
 107                                              const gchar        *name);
 108 void     gtk_widget_path_iter_clear_regions (GtkWidgetPath      *path,
 109                                              gint                pos);
 110
 111 GSList * gtk_widget_path_iter_list_regions  (const GtkWidgetPath *path,
 112                                              gint                 pos);
 113
 114 gboolean gtk_widget_path_iter_has_region    (const GtkWidgetPath *path,
 115                                              gint                 pos,
 116                                              const gchar         *name,
 117                                              GtkRegionFlags      *flags);
 118 gboolean gtk_widget_path_iter_has_qregion   (const GtkWidgetPath *path,
 119                                              gint                 pos,
 120                                              GQuark               qname,
 121                                              GtkRegionFlags      *flags);
 122
 123 GType           gtk_widget_path_get_object_type (const GtkWidgetPath *path);
 124
 125 gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
 126                                             GType                type);
 127 gboolean        gtk_widget_path_has_parent (const GtkWidgetPath *path,
 128                                             GType                type);
 129
 130 G_END_DECLS
 131
 132 #endif /* __GTK_WIDGET_PATH_H__ */