1 /*
2  * gtkoverlay.h
3  * This file is part of gtk
4  *
5  * Copyright (C) 2011 - Ignacio Casal Quinteiro
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __GTK_OVERLAY_H__
22 #define __GTK_OVERLAY_H__
23 
24 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25 #error "Only <gtk/gtk.h> can be included directly."
26 #endif
27 
28 #include <gtk/gtkwidget.h>
29 
30 G_BEGIN_DECLS
31 
32 #define GTK_TYPE_OVERLAY             (gtk_overlay_get_type ())
33 #define GTK_OVERLAY(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_OVERLAY, GtkOverlay))
34 #define GTK_IS_OVERLAY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_OVERLAY))
35 
36 typedef struct _GtkOverlay         GtkOverlay;
37 
38 GDK_AVAILABLE_IN_ALL
39 GType      gtk_overlay_get_type    (void) G_GNUC_CONST;
40 GDK_AVAILABLE_IN_ALL
41 GtkWidget *gtk_overlay_new         (void);
42 GDK_AVAILABLE_IN_ALL
43 void       gtk_overlay_add_overlay (GtkOverlay *overlay,
44                                     GtkWidget  *widget);
45 GDK_AVAILABLE_IN_ALL
46 void       gtk_overlay_remove_overlay (GtkOverlay *overlay,
47                                        GtkWidget  *widget);
48 
49 GDK_AVAILABLE_IN_ALL
50 void                  gtk_overlay_set_child (GtkOverlay *overlay,
51                                              GtkWidget  *child);
52 GDK_AVAILABLE_IN_ALL
53 GtkWidget *           gtk_overlay_get_child (GtkOverlay *overlay);
54 
55 GDK_AVAILABLE_IN_ALL
56 gboolean   gtk_overlay_get_measure_overlay (GtkOverlay *overlay,
57                                             GtkWidget  *widget);
58 GDK_AVAILABLE_IN_ALL
59 void       gtk_overlay_set_measure_overlay (GtkOverlay *overlay,
60                                             GtkWidget  *widget,
61                                             gboolean    measure);
62 GDK_AVAILABLE_IN_ALL
63 gboolean   gtk_overlay_get_clip_overlay    (GtkOverlay *overlay,
64                                             GtkWidget  *widget);
65 GDK_AVAILABLE_IN_ALL
66 void       gtk_overlay_set_clip_overlay    (GtkOverlay *overlay,
67                                             GtkWidget  *widget,
68                                             gboolean    clip_overlay);
69 
70 G_END_DECLS
71 
72 #endif /* __GTK_OVERLAY_H__ */
73