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 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  19 #error "Only <gtk/gtk.h> can be included directly."
  20 #endif
  21
  22 #ifndef __GTK_WIDGET_PATH_H__
  23 #define __GTK_WIDGET_PATH_H__
  24
  25 #include <glib-object.h>
  26 #include <gdk/gdk.h>
  27 #include <gtk/gtkenums.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef struct _GtkWidgetPath GtkWidgetPath;
  32
  33 /* We make this forward declaration here, since gtkwidget.h includes us.
  34  */
  35 typedef struct _GtkWidget      GtkWidget;
  36
  37 #define GTK_TYPE_WIDGET_PATH (gtk_widget_path_get_type ())
  38
  39 GType           gtk_widget_path_get_type            (void) G_GNUC_CONST;
  40 GtkWidgetPath * gtk_widget_path_new                 (void);
  41
  42 GtkWidgetPath * gtk_widget_path_copy                (const GtkWidgetPath *path);
  43 GDK_AVAILABLE_IN_3_2
  44 GtkWidgetPath * gtk_widget_path_ref                 (GtkWidgetPath       *path);
  45 GDK_AVAILABLE_IN_3_2
  46 void            gtk_widget_path_unref               (GtkWidgetPath       *path);
  47 void            gtk_widget_path_free                (GtkWidgetPath       *path);
  48
  49 GDK_AVAILABLE_IN_3_2
  50 char *          gtk_widget_path_to_string           (const GtkWidgetPath *path);
  51 gint            gtk_widget_path_length              (const GtkWidgetPath *path);
  52
  53 gint            gtk_widget_path_append_type         (GtkWidgetPath       *path,
  54                                                      GType                type);
  55 void            gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
  56                                                      GType                type);
  57 GDK_AVAILABLE_IN_3_2
  58 gint            gtk_widget_path_append_with_siblings(GtkWidgetPath       *path,
  59                                                      GtkWidgetPath       *siblings,
  60                                                      guint                sibling_index);
  61 /* gtk_widget_path_append_for_widget() is declared in gtkwidget.c */
  62 GDK_AVAILABLE_IN_3_2
  63 gint            gtk_widget_path_append_for_widget   (GtkWidgetPath       *path,
  64                                                      GtkWidget           *widget);
  65
  66 GType               gtk_widget_path_iter_get_object_type  (const GtkWidgetPath *path,
  67                                                            gint                 pos);
  68 void                gtk_widget_path_iter_set_object_type  (GtkWidgetPath       *path,
  69                                                            gint                 pos,
  70                                                            GType                type);
  71 const GtkWidgetPath *
  72                     gtk_widget_path_iter_get_siblings     (const GtkWidgetPath *path,
  73                                                            gint                 pos);
  74 guint               gtk_widget_path_iter_get_sibling_index(const GtkWidgetPath *path,
  75                                                            gint                 pos);
  76
  77 const gchar *          gtk_widget_path_iter_get_name  (const GtkWidgetPath *path,
  78                                                        gint                 pos);
  79 void                   gtk_widget_path_iter_set_name  (GtkWidgetPath       *path,
  80                                                        gint                 pos,
  81                                                        const gchar         *name);
  82 gboolean               gtk_widget_path_iter_has_name  (const GtkWidgetPath *path,
  83                                                        gint                 pos,
  84                                                        const gchar         *name);
  85 gboolean               gtk_widget_path_iter_has_qname (const GtkWidgetPath *path,
  86                                                        gint                 pos,
  87                                                        GQuark               qname);
  88
  89 void     gtk_widget_path_iter_add_class     (GtkWidgetPath       *path,
  90                                              gint                 pos,
  91                                              const gchar         *name);
  92 void     gtk_widget_path_iter_remove_class  (GtkWidgetPath       *path,
  93                                              gint                 pos,
  94                                              const gchar         *name);
  95 void     gtk_widget_path_iter_clear_classes (GtkWidgetPath       *path,
  96                                              gint                 pos);
  97 GSList * gtk_widget_path_iter_list_classes  (const GtkWidgetPath *path,
  98                                              gint                 pos);
  99 gboolean gtk_widget_path_iter_has_class     (const GtkWidgetPath *path,
 100                                              gint                 pos,
 101                                              const gchar         *name);
 102 gboolean gtk_widget_path_iter_has_qclass    (const GtkWidgetPath *path,
 103                                              gint                 pos,
 104                                              GQuark               qname);
 105
 106 void     gtk_widget_path_iter_add_region    (GtkWidgetPath      *path,
 107                                              gint                pos,
 108                                              const gchar        *name,
 109                                              GtkRegionFlags     flags);
 110 void     gtk_widget_path_iter_remove_region (GtkWidgetPath      *path,
 111                                              gint                pos,
 112                                              const gchar        *name);
 113 void     gtk_widget_path_iter_clear_regions (GtkWidgetPath      *path,
 114                                              gint                pos);
 115
 116 GSList * gtk_widget_path_iter_list_regions  (const GtkWidgetPath *path,
 117                                              gint                 pos);
 118
 119 gboolean gtk_widget_path_iter_has_region    (const GtkWidgetPath *path,
 120                                              gint                 pos,
 121                                              const gchar         *name,
 122                                              GtkRegionFlags      *flags);
 123 gboolean gtk_widget_path_iter_has_qregion   (const GtkWidgetPath *path,
 124                                              gint                 pos,
 125                                              GQuark               qname,
 126                                              GtkRegionFlags      *flags);
 127
 128 GType           gtk_widget_path_get_object_type (const GtkWidgetPath *path);
 129
 130 gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
 131                                             GType                type);
 132 gboolean        gtk_widget_path_has_parent (const GtkWidgetPath *path,
 133                                             GType                type);
 134
 135 G_END_DECLS
 136
 137 #endif /* __GTK_WIDGET_PATH_H__ */