]> Pileus Git - ~andy/gtk/blob - gtk/gtkwidgetpath.h
GtkWidgetPath: Make API more consistent.
[~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 #ifndef __GTK_WIDGET_PATH_H__
21 #define __GTK_WIDGET_PATH_H__
22
23 #include <glib-object.h>
24 #include "gtkenums.h"
25
26 G_BEGIN_DECLS
27
28 typedef struct GtkWidgetPath GtkWidgetPath;
29
30
31 GtkWidgetPath * gtk_widget_path_new (void);
32
33 GtkWidgetPath * gtk_widget_path_copy                (const GtkWidgetPath *path);
34 void            gtk_widget_path_free                (GtkWidgetPath       *path);
35
36 guint           gtk_widget_path_length              (const GtkWidgetPath *path);
37
38 guint           gtk_widget_path_prepend_type        (GtkWidgetPath       *path,
39                                                      GType                type);
40
41 GType               gtk_widget_path_iter_get_widget_type (const GtkWidgetPath *path,
42                                                           guint                pos);
43 void                gtk_widget_path_iter_set_widget_type (GtkWidgetPath       *path,
44                                                           guint                pos,
45                                                           GType                type);
46
47 G_CONST_RETURN gchar * gtk_widget_path_iter_get_name (const GtkWidgetPath *path,
48                                                       guint                pos);
49 void                   gtk_widget_path_iter_set_name (GtkWidgetPath       *path,
50                                                       guint                pos,
51                                                       const gchar         *name);
52
53 void     gtk_widget_path_iter_add_region    (GtkWidgetPath      *path,
54                                              guint               pos,
55                                              const gchar        *name,
56                                              GtkChildClassFlags  flags);
57 void     gtk_widget_path_iter_remove_region (GtkWidgetPath      *path,
58                                              guint               pos,
59                                              const gchar        *name);
60 void     gtk_widget_path_iter_clear_regions (GtkWidgetPath      *path,
61                                              guint               pos);
62
63 GSList * gtk_widget_path_iter_list_regions  (const GtkWidgetPath *path,
64                                              guint                pos);
65
66 gboolean gtk_widget_path_iter_has_region    (const GtkWidgetPath *path,
67                                              guint                pos,
68                                              const gchar         *name,
69                                              GtkChildClassFlags  *flags);
70 gboolean gtk_widget_path_iter_has_qregion   (const GtkWidgetPath *path,
71                                              guint                pos,
72                                              GQuark               qname,
73                                              GtkChildClassFlags  *flags);
74
75 GType           gtk_widget_path_get_widget_type (const GtkWidgetPath *path);
76
77 gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
78                                             GType                type);
79 gboolean        gtk_widget_path_has_parent (const GtkWidgetPath *path,
80                                             GType                type);
81
82 G_END_DECLS
83
84 #endif /* __GTK_WIDGET_PATH_H__ */