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