overlay: add initial version of gtkoverlay

1 files changed, 447 insertions, 0 deletions

diff --git a/tests/testoverlay.c b/tests/testoverlay.c
new file mode 100644
index 0000000000..d59032c33a
--- /dev/null
+++ b/tests/testoverlay.c
@@ -0,0 +1,447 @@
+#include <string.h>
+#include <gtk/gtk.h>
+
+/* test that margins and non-zero allocation x/y
+ * of the main widget are handled correctly
+ */
+static GtkWidget *
+test_nonzerox (void)
+{
+  GtkWidget *win;
+  GtkWidget *grid;
+  GtkWidget *overlay;
+  GtkWidget *text;
+  GtkWidget *child;
+  GdkRGBA color;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Non-zero X");
+
+  grid = gtk_grid_new ();
+  g_object_set (grid, "margin", 5, NULL);
+  gtk_container_add (GTK_CONTAINER (win), grid);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Above"), 1, 0, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Below"), 1, 2, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Left"), 0, 1, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Right"), 2, 1, 1, 1);
+
+  overlay = gtk_overlay_new ();
+  gdk_rgba_parse (&color, "red");
+  gtk_widget_override_background_color (overlay, 0, &color);
+  gtk_grid_attach (GTK_GRID (grid), overlay, 1, 1, 1, 1);
+
+  text = gtk_text_view_new ();
+  gtk_widget_set_size_request (text, 200, 200);
+  gtk_widget_set_hexpand (text, TRUE);
+  gtk_widget_set_vexpand (text, TRUE);
+  gtk_container_add (GTK_CONTAINER (overlay), text);
+
+  child = gtk_label_new ("I'm the overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_START);
+  gtk_widget_set_valign (child, GTK_ALIGN_START);
+  g_object_set (child, "margin", 3, NULL);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+
+  child = gtk_label_new ("No, I'm the overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_END);
+  gtk_widget_set_valign (child, GTK_ALIGN_END);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 3, NULL);
+
+  return win;
+}
+
+static gboolean
+get_child_position (GtkOverlay    *overlay,
+                    GtkWidget     *widget,
+                    GtkAllocation *alloc,
+                    GtkWidget     *relative)
+{
+  GtkRequisition req;
+  GtkWidget *child;
+  GtkAllocation main_alloc;
+  gint x, y;
+
+  child = gtk_bin_get_child (GTK_BIN (overlay));
+
+  gtk_widget_translate_coordinates (relative, child, 0, 0, &x, &y);
+  main_alloc.x = x;
+  main_alloc.y = y;
+  main_alloc.width = gtk_widget_get_allocated_width (relative);
+  main_alloc.height = gtk_widget_get_allocated_height (relative);
+
+  gtk_widget_get_preferred_size (widget, NULL, &req);
+
+  alloc->x = main_alloc.x;
+  alloc->width = MIN (main_alloc.width, req.width);
+  if (gtk_widget_get_halign (widget) == GTK_ALIGN_END)
+    alloc->x += main_alloc.width - req.width;
+
+  alloc->y = main_alloc.y;
+  alloc->height = MIN (main_alloc.height, req.height);
+  if (gtk_widget_get_valign (widget) == GTK_ALIGN_END)
+    alloc->y += main_alloc.height - req.height;
+
+  return TRUE;
+}
+
+/* test custom positioning */
+static GtkWidget *
+test_relative (void)
+{
+  GtkWidget *win;
+  GtkWidget *grid;
+  GtkWidget *overlay;
+  GtkWidget *text;
+  GtkWidget *child;
+  GdkRGBA color;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Custom positioning");
+
+  overlay = gtk_overlay_new ();
+  gdk_rgba_parse (&color, "yellow");
+  gtk_widget_override_background_color (overlay, 0, &color);
+  gtk_container_add (GTK_CONTAINER (win), overlay);
+
+  grid = gtk_grid_new ();
+  gtk_container_add (GTK_CONTAINER (overlay), grid);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Above"), 1, 0, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Below"), 1, 2, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Left"), 0, 1, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), gtk_label_new ("Right"), 2, 1, 1, 1);
+
+  text = gtk_text_view_new ();
+  gtk_widget_set_size_request (text, 200, 200);
+  g_object_set (text, "margin", 5, NULL);
+  gtk_widget_set_hexpand (text, TRUE);
+  gtk_widget_set_vexpand (text, TRUE);
+  gtk_grid_attach (GTK_GRID (grid), text, 1, 1, 1, 1);
+  g_signal_connect (overlay, "get-child-position",
+                    G_CALLBACK (get_child_position), text);
+
+  child = gtk_label_new ("Top left overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_START);
+  gtk_widget_set_valign (child, GTK_ALIGN_START);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 1, NULL);
+
+  child = gtk_label_new ("Bottom right overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_END);
+  gtk_widget_set_valign (child, GTK_ALIGN_END);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 1, NULL);
+
+  return win;
+}
+
+/* test GTK_ALIGN_FILL handling */
+static GtkWidget *
+test_fullwidth (void)
+{
+  GtkWidget *win;
+  GtkWidget *overlay;
+  GtkWidget *text;
+  GtkWidget *child;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Full-width");
+
+  overlay = gtk_overlay_new ();
+  gtk_container_add (GTK_CONTAINER (win), overlay);
+
+  text = gtk_text_view_new ();
+  gtk_widget_set_size_request (text, 200, 200);
+  gtk_widget_set_hexpand (text, TRUE);
+  gtk_widget_set_vexpand (text, TRUE);
+  gtk_container_add (GTK_CONTAINER (overlay), text);
+
+  child = gtk_label_new ("Fullwidth top overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_FILL);
+  gtk_widget_set_valign (child, GTK_ALIGN_START);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 4, NULL);
+
+  return win;
+}
+
+/* test that scrolling works as expected */
+static GtkWidget *
+test_scrolling (void)
+{
+  GtkWidget *win;
+  GtkWidget *overlay;
+  GtkWidget *sw;
+  GtkWidget *text;
+  GtkWidget *child;
+  GtkTextBuffer *buffer;
+  gchar *contents;
+  gsize len;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Scrolling");
+
+  overlay = gtk_overlay_new ();
+  gtk_container_add (GTK_CONTAINER (win), overlay);
+
+  sw = gtk_scrolled_window_new (NULL, NULL);
+  gtk_scrolled_window_set_min_content_width (GTK_SCROLLED_WINDOW (sw), 200);
+  gtk_scrolled_window_set_min_content_height (GTK_SCROLLED_WINDOW (sw), 200);
+  gtk_container_add (GTK_CONTAINER (overlay), sw);
+
+  text = gtk_text_view_new ();
+  buffer = gtk_text_buffer_new (NULL);
+  if (!g_file_get_contents ("testoverlay.c", &contents, &len, NULL))
+    {
+      contents = g_strdup ("Text should go here...");
+      len = strlen (contents);
+    }
+  gtk_text_buffer_set_text (buffer, contents, len);
+  g_free (contents);
+  gtk_text_view_set_buffer (GTK_TEXT_VIEW (text), buffer);
+
+  gtk_widget_set_hexpand (text, TRUE);
+  gtk_widget_set_vexpand (text, TRUE);
+  gtk_container_add (GTK_CONTAINER (sw), text);
+
+  child = gtk_label_new ("This should be visible");
+  gtk_widget_set_halign (child, GTK_ALIGN_CENTER);
+  gtk_widget_set_valign (child, GTK_ALIGN_END);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 4, NULL);
+
+  return win;
+}
+
+static const gchar *buffer =
+"<interface>"
+"  <object class='GtkWindow' id='window'>"
+"    <property name='title'>GtkBuilder support</property>"
+"    <child>"
+"      <object class='GtkOverlay' id='overlay'>"
+"        <child type='overlay'>"
+"          <object class='GtkLabel' id='overlay-child'>"
+"            <property name='label'>Witty remark goes here</property>"
+"            <property name='halign'>end</property>"
+"            <property name='valign'>end</property>"
+"            <property name='margin'>4</property>"
+"          </object>"
+"        </child>"
+"        <child>"
+"          <object class='GtkGrid' id='grid'>"
+"            <child>"
+"              <object class='GtkLabel' id='left'>"
+"                <property name='label'>Left</property>"
+"              </object>"
+"              <packing>"
+"                <property name='left_attach'>0</property>"
+"                <property name='top_attach'>0</property>"
+"              </packing>"
+"            </child>"
+"            <child>"
+"              <object class='GtkLabel' id='right'>"
+"                <property name='label'>Right</property>"
+"              </object>"
+"              <packing>"
+"                <property name='left_attach'>2</property>"
+"                <property name='top_attach'>0</property>"
+"              </packing>"
+"            </child>"
+"            <child>"
+"              <object class='GtkTextView' id='text'>"
+"                 <property name='width-request'>200</property>"
+"                 <property name='height-request'>200</property>"
+"                 <property name='hexpand'>True</property>"
+"                 <property name='vexpand'>True</property>"
+"              </object>"
+"              <packing>"
+"                <property name='left_attach'>1</property>"
+"                <property name='top_attach'>0</property>"
+"              </packing>"
+"            </child>"
+"          </object>"
+"        </child>"
+"      </object>"
+"    </child>"
+"  </object>"
+"</interface>";
+
+/* test that overlays can be constructed with GtkBuilder */
+static GtkWidget *
+test_builder (void)
+{
+  GtkBuilder *builder;
+  GtkWidget *win;
+  GError *error;
+
+  builder = gtk_builder_new ();
+
+  error = NULL;
+  if (!gtk_builder_add_from_string (builder, buffer, -1, &error))
+    {
+      g_warning ("%s", error->message);
+      g_error_free (error);
+      return NULL;
+    }
+
+  win = (GtkWidget *)gtk_builder_get_object (builder, "window");
+  g_object_ref (win);
+
+  g_object_unref (builder);
+
+  return win;
+}
+
+static void
+on_enter (GtkWidget *overlay, GdkEventCrossing *event, GtkWidget *child)
+{
+  if (event->window != gtk_widget_get_window (child))
+    return;
+
+  if (gtk_widget_get_halign (child) == GTK_ALIGN_START)
+    gtk_widget_set_halign (child, GTK_ALIGN_END);
+  else
+    gtk_widget_set_halign (child, GTK_ALIGN_START);
+
+  gtk_widget_queue_resize (overlay);
+}
+
+static GtkWidget *
+test_chase (void)
+{
+  GtkWidget *win;
+  GtkWidget *overlay;
+  GtkWidget *sw;
+  GtkWidget *text;
+  GtkWidget *child;
+  GtkTextBuffer *buffer;
+  gchar *contents;
+  gsize len;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Chase");
+
+  overlay = gtk_overlay_new ();
+  gtk_widget_set_events (overlay, GDK_ENTER_NOTIFY_MASK|GDK_LEAVE_NOTIFY_MASK);
+  gtk_container_add (GTK_CONTAINER (win), overlay);
+
+  sw = gtk_scrolled_window_new (NULL, NULL);
+  gtk_scrolled_window_set_min_content_width (GTK_SCROLLED_WINDOW (sw), 200);
+  gtk_scrolled_window_set_min_content_height (GTK_SCROLLED_WINDOW (sw), 200);
+  gtk_container_add (GTK_CONTAINER (overlay), sw);
+
+  text = gtk_text_view_new ();
+  buffer = gtk_text_buffer_new (NULL);
+  if (!g_file_get_contents ("testoverlay.c", &contents, &len, NULL))
+    {
+      contents = g_strdup ("Text should go here...");
+      len = strlen (contents);
+    }
+  gtk_text_buffer_set_text (buffer, contents, len);
+  g_free (contents);
+  gtk_text_view_set_buffer (GTK_TEXT_VIEW (text), buffer);
+
+  gtk_widget_set_hexpand (text, TRUE);
+  gtk_widget_set_vexpand (text, TRUE);
+  gtk_container_add (GTK_CONTAINER (sw), text);
+
+  child = gtk_label_new ("Try to enter");
+  gtk_widget_set_halign (child, GTK_ALIGN_START);
+  gtk_widget_set_valign (child, GTK_ALIGN_END);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  g_object_set (child, "margin", 4, NULL);
+
+  g_signal_connect (overlay, "enter-notify-event",
+                    G_CALLBACK (on_enter), child);
+  return win;
+}
+
+static GtkWidget *
+test_stacking (void)
+{
+  GtkWidget *win;
+  GtkWidget *overlay;
+  GtkWidget *main_child;
+  GtkWidget *label;
+  GtkWidget *child;
+  GtkWidget *grid;
+  GtkWidget *check1;
+  GtkWidget *check2;
+  GdkRGBA color;
+
+  win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+  gtk_window_set_title (GTK_WINDOW (win), "Stacking");
+
+  grid = gtk_grid_new ();
+  overlay = gtk_overlay_new ();
+  main_child = gtk_event_box_new ();
+  gdk_rgba_parse (&color, "green");
+  gtk_widget_override_background_color (main_child, 0, &color);
+  gtk_widget_set_hexpand (main_child, TRUE);
+  gtk_widget_set_vexpand (main_child, TRUE);
+  label = gtk_label_new ("Main child");
+  child = gtk_label_new ("Overlay");
+  gtk_widget_set_halign (child, GTK_ALIGN_END);
+  gtk_widget_set_valign (child, GTK_ALIGN_END);
+
+  check1 = gtk_check_button_new_with_label ("Show main");
+  g_object_bind_property (main_child, "visible", check1, "active", G_BINDING_BIDIRECTIONAL);
+
+  check2 = gtk_check_button_new_with_label ("Show overlay");
+  g_object_bind_property (child, "visible", check2, "active", G_BINDING_BIDIRECTIONAL);
+  gtk_container_add (GTK_CONTAINER (main_child), label);
+  gtk_container_add (GTK_CONTAINER (overlay), main_child);
+  gtk_overlay_add_overlay (GTK_OVERLAY (overlay), child);
+  gtk_grid_attach (GTK_GRID (grid), overlay, 1, 0, 1, 3);
+  gtk_container_add (GTK_CONTAINER (win), grid);
+
+  gtk_grid_attach (GTK_GRID (grid), check1, 0, 0, 1, 1);
+  gtk_grid_attach (GTK_GRID (grid), check2, 0, 1, 1, 1);
+  child = gtk_label_new ("");
+  gtk_widget_set_vexpand (child, TRUE);
+  gtk_grid_attach (GTK_GRID (grid), child, 0, 2, 1, 1);
+
+  return win;
+}
+
+int
+main (int argc, char *argv[])
+{
+  GtkWidget *win1;
+  GtkWidget *win2;
+  GtkWidget *win3;
+  GtkWidget *win4;
+  GtkWidget *win5;
+  GtkWidget *win6;
+  GtkWidget *win7;
+
+  gtk_init (&argc, &argv);
+
+  if (g_getenv ("RTL"))
+    gtk_widget_set_default_direction (GTK_TEXT_DIR_RTL);
+
+  win1 = test_nonzerox ();
+  gtk_widget_show_all (win1);
+
+  win2 = test_relative ();
+  gtk_widget_show_all (win2);
+
+  win3 = test_fullwidth ();
+  gtk_widget_show_all (win3);
+
+  win4 = test_scrolling ();
+  gtk_widget_show_all (win4);
+
+  win5 = test_builder ();
+  gtk_widget_show_all (win5);
+
+  win6 = test_chase ();
+  gtk_widget_show_all (win6);
+
+  win7 = test_stacking ();
+  gtk_widget_show_all (win7);
+
+  gtk_main ();
+
+  return 0;
+}