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/gtkbin.h>
29
30G_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_OVERLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_OVERLAY, GtkOverlayClass))
35#define GTK_IS_OVERLAY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_OVERLAY))
36#define GTK_IS_OVERLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_OVERLAY))
37#define GTK_OVERLAY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_OVERLAY, GtkOverlayClass))
38
39typedef struct _GtkOverlay GtkOverlay;
40typedef struct _GtkOverlayClass GtkOverlayClass;
41typedef struct _GtkOverlayPrivate GtkOverlayPrivate;
42
43struct _GtkOverlay
44{
45 GtkBin parent;
46
47 GtkOverlayPrivate *priv;
48};
49
50/**
51 * GtkOverlayClass:
52 * @parent_class: The parent class.
53 * @get_child_position: Signal emitted to determine the position and
54 * size of any overlay child widgets.
55 */
56struct _GtkOverlayClass
57{
58 GtkBinClass parent_class;
59
60 /*< public >*/
61
62 gboolean (*get_child_position) (GtkOverlay *overlay,
63 GtkWidget *widget,
64 GtkAllocation *allocation);
65
66 /*< private >*/
67
68 /* Padding for future expansion */
69 void (*_gtk_reserved1) (void);
70 void (*_gtk_reserved2) (void);
71 void (*_gtk_reserved3) (void);
72 void (*_gtk_reserved4) (void);
73 void (*_gtk_reserved5) (void);
74 void (*_gtk_reserved6) (void);
75 void (*_gtk_reserved7) (void);
76 void (*_gtk_reserved8) (void);
77};
78
79GDK_AVAILABLE_IN_3_2
80GType gtk_overlay_get_type (void) G_GNUC_CONST;
81GDK_AVAILABLE_IN_3_2
82GtkWidget *gtk_overlay_new (void);
83GDK_AVAILABLE_IN_3_2
84void gtk_overlay_add_overlay (GtkOverlay *overlay,
85 GtkWidget *widget);
86GDK_AVAILABLE_IN_3_18
87void gtk_overlay_reorder_overlay (GtkOverlay *overlay,
88 GtkWidget *child,
89 gint position);
90GDK_AVAILABLE_IN_3_18
91gboolean gtk_overlay_get_overlay_pass_through (GtkOverlay *overlay,
92 GtkWidget *widget);
93GDK_AVAILABLE_IN_3_18
94void gtk_overlay_set_overlay_pass_through (GtkOverlay *overlay,
95 GtkWidget *widget,
96 gboolean pass_through);
97
98G_END_DECLS
99
100#endif /* __GTK_OVERLAY_H__ */
101