]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidgetpath.h
API: Add gtk_widget_path_append_for_widget()
[~andy/gtk] / 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 void            gtk_widget_path_free                (GtkWidgetPath       *path);
45
46 char *          gtk_widget_path_to_string           (const GtkWidgetPath *path);
47 gint            gtk_widget_path_length              (const GtkWidgetPath *path);
48
49 gint            gtk_widget_path_append_type         (GtkWidgetPath       *path,
50                                                      GType                type);
51 void            gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
52                                                      GType                type);
53 /* gtk_widget_path_append_for_widget() is declared in gtkwidget.c */
54 gint            gtk_widget_path_append_for_widget   (GtkWidgetPath       *path,
55                                                      GtkWidget           *widget);
56
57 GType               gtk_widget_path_iter_get_object_type (const GtkWidgetPath *path,
58                                                           gint                 pos);
59 void                gtk_widget_path_iter_set_object_type (GtkWidgetPath       *path,
60                                                           gint                 pos,
61                                                           GType                type);
62
63 G_CONST_RETURN gchar * gtk_widget_path_iter_get_name  (const GtkWidgetPath *path,
64                                                        gint                 pos);
65 void                   gtk_widget_path_iter_set_name  (GtkWidgetPath       *path,
66                                                        gint                 pos,
67                                                        const gchar         *name);
68 gboolean               gtk_widget_path_iter_has_name  (const GtkWidgetPath *path,
69                                                        gint                 pos,
70                                                        const gchar         *name);
71 gboolean               gtk_widget_path_iter_has_qname (const GtkWidgetPath *path,
72                                                        gint                 pos,
73                                                        GQuark               qname);
74
75 void     gtk_widget_path_iter_add_class     (GtkWidgetPath       *path,
76                                              gint                 pos,
77                                              const gchar         *name);
78 void     gtk_widget_path_iter_remove_class  (GtkWidgetPath       *path,
79                                              gint                 pos,
80                                              const gchar         *name);
81 void     gtk_widget_path_iter_clear_classes (GtkWidgetPath       *path,
82                                              gint                 pos);
83 GSList * gtk_widget_path_iter_list_classes  (const GtkWidgetPath *path,
84                                              gint                 pos);
85 gboolean gtk_widget_path_iter_has_class     (const GtkWidgetPath *path,
86                                              gint                 pos,
87                                              const gchar         *name);
88 gboolean gtk_widget_path_iter_has_qclass    (const GtkWidgetPath *path,
89                                              gint                 pos,
90                                              GQuark               qname);
91
92 void     gtk_widget_path_iter_add_region    (GtkWidgetPath      *path,
93                                              gint                pos,
94                                              const gchar        *name,
95                                              GtkRegionFlags     flags);
96 void     gtk_widget_path_iter_remove_region (GtkWidgetPath      *path,
97                                              gint                pos,
98                                              const gchar        *name);
99 void     gtk_widget_path_iter_clear_regions (GtkWidgetPath      *path,
100                                              gint                pos);
101
102 GSList * gtk_widget_path_iter_list_regions  (const GtkWidgetPath *path,
103                                              gint                 pos);
104
105 gboolean gtk_widget_path_iter_has_region    (const GtkWidgetPath *path,
106                                              gint                 pos,
107                                              const gchar         *name,
108                                              GtkRegionFlags      *flags);
109 gboolean gtk_widget_path_iter_has_qregion   (const GtkWidgetPath *path,
110                                              gint                 pos,
111                                              GQuark               qname,
112                                              GtkRegionFlags      *flags);
113
114 GType           gtk_widget_path_get_object_type (const GtkWidgetPath *path);
115
116 gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
117                                             GType                type);
118 gboolean        gtk_widget_path_has_parent (const GtkWidgetPath *path,
119                                             GType                type);
120
121 G_END_DECLS
122
123 #endif /* __GTK_WIDGET_PATH_H__ */