gtkwidgetpath.h 7.2 KB
Newer Older
Carlos Garnacho's avatar
Carlos Garnacho committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* GTK - The GIMP Toolkit
 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

20 21 22 23
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Carlos Garnacho's avatar
Carlos Garnacho committed
24 25 26 27
#ifndef __GTK_WIDGET_PATH_H__
#define __GTK_WIDGET_PATH_H__

#include <glib-object.h>
28
#include <gtk/gtkenums.h>
Carlos Garnacho's avatar
Carlos Garnacho committed
29 30 31

G_BEGIN_DECLS

Carlos Garnacho's avatar
Carlos Garnacho committed
32
typedef struct _GtkWidgetPath GtkWidgetPath;
Carlos Garnacho's avatar
Carlos Garnacho committed
33

34 35 36 37
/* We make this forward declaration here, since gtkwidget.h includes us.
 */
typedef struct _GtkWidget      GtkWidget;

38
#define GTK_TYPE_WIDGET_PATH (gtk_widget_path_get_type ())
Carlos Garnacho's avatar
Carlos Garnacho committed
39

40
GType           gtk_widget_path_get_type            (void) G_GNUC_CONST;
41
GtkWidgetPath * gtk_widget_path_new                 (void);
Carlos Garnacho's avatar
Carlos Garnacho committed
42

43
GtkWidgetPath * gtk_widget_path_copy                (const GtkWidgetPath *path);
44 45
GtkWidgetPath * gtk_widget_path_ref                 (GtkWidgetPath       *path);
void            gtk_widget_path_unref               (GtkWidgetPath       *path);
46
void            gtk_widget_path_free                (GtkWidgetPath       *path);
Carlos Garnacho's avatar
Carlos Garnacho committed
47

48
char *          gtk_widget_path_to_string           (const GtkWidgetPath *path);
49
gint            gtk_widget_path_length              (const GtkWidgetPath *path);
Carlos Garnacho's avatar
Carlos Garnacho committed
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 56 57
gint            gtk_widget_path_append_with_siblings(GtkWidgetPath       *path,
                                                     GtkWidgetPath       *siblings,
                                                     guint                sibling_index);
58 59 60
/* gtk_widget_path_append_for_widget() is declared in gtkwidget.c */
gint            gtk_widget_path_append_for_widget   (GtkWidgetPath       *path,
                                                     GtkWidget           *widget);
Carlos Garnacho's avatar
Carlos Garnacho committed
61

62 63 64 65 66 67 68 69 70 71
GType               gtk_widget_path_iter_get_object_type  (const GtkWidgetPath *path,
                                                           gint                 pos);
void                gtk_widget_path_iter_set_object_type  (GtkWidgetPath       *path,
                                                           gint                 pos,
                                                           GType                type);
const GtkWidgetPath *
                    gtk_widget_path_iter_get_siblings     (const GtkWidgetPath *path,
                                                           gint                 pos);
guint               gtk_widget_path_iter_get_sibling_index(const GtkWidgetPath *path,
                                                           gint                 pos);
Carlos Garnacho's avatar
Carlos Garnacho committed
72

73
const 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 78
                                                       const gchar         *name);
gboolean               gtk_widget_path_iter_has_name  (const GtkWidgetPath *path,
79
                                                       gint                 pos,
80 81
                                                       const gchar         *name);
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 88
                                             const gchar         *name);
void     gtk_widget_path_iter_remove_class  (GtkWidgetPath       *path,
89
                                             gint                 pos,
90 91
                                             const gchar         *name);
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 98
                                             const gchar         *name);
gboolean gtk_widget_path_iter_has_qclass    (const GtkWidgetPath *path,
99
                                             gint                 pos,
100 101
                                             GQuark               qname);

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 109
                                             const gchar        *name);
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 127 128 129

gboolean        gtk_widget_path_is_type    (const GtkWidgetPath *path,
                                            GType                type);
gboolean        gtk_widget_path_has_parent (const GtkWidgetPath *path,
                                            GType                type);
Carlos Garnacho's avatar
Carlos Garnacho committed
130 131 132 133

G_END_DECLS

#endif /* __GTK_WIDGET_PATH_H__ */