[gnome-builder] GbScrolledWindow: a new scroller that will grow/shrink with child contents

[Christian Hergert <chergert src gnome org>]

commit 97538bb3ffd43f302593410e92a961e14bf2f1cc
Author: Christian Hergert <christian hergert me>
Date:   Wed Dec 17 17:08:38 2014 -0800

    GbScrolledWindow: a new scroller that will grow/shrink with child contents
    
    This allows you to have a GtkScrolledWindow that will be at least
    min_content_height/min_content_width big, but grow to no more than
    max_content_height/max_content_height big.

 src/gnome-builder.mk                    |    3 +
 src/scrolledwindow/gb-scrolled-window.c |  270 +++++++++++++++++++++++++++++++
 src/scrolledwindow/gb-scrolled-window.h |   56 +++++++
 3 files changed, 329 insertions(+), 0 deletions(-)
---
diff --git a/src/gnome-builder.mk b/src/gnome-builder.mk
index d0f7a29..1f71421 100644
--- a/src/gnome-builder.mk
+++ b/src/gnome-builder.mk
@@ -130,6 +130,8 @@ libgnome_builder_la_SOURCES = \
        src/preferences/gb-preferences-page-git.h \
        src/preferences/gb-preferences-page-language.c \
        src/preferences/gb-preferences-page-language.h \
+       src/scrolledwindow/gb-scrolled-window.c \
+       src/scrolledwindow/gb-scrolled-window.h \
        src/snippets/gb-source-snippet-chunk.c \
        src/snippets/gb-source-snippet-chunk.h \
        src/snippets/gb-source-snippet-completion-item.c \
@@ -248,6 +250,7 @@ libgnome_builder_la_CFLAGS = \
        -I$(top_srcdir)/src/preferences \
        -I$(top_srcdir)/src/resources \
        -I$(top_builddir)/src/resources \
+       -I$(top_srcdir)/src/scrolledwindow \
        -I$(top_srcdir)/src/search \
        -I$(top_srcdir)/src/snippets \
        -I$(top_srcdir)/src/tabs \
diff --git a/src/scrolledwindow/gb-scrolled-window.c b/src/scrolledwindow/gb-scrolled-window.c
new file mode 100644
index 0000000..f0bee11
--- /dev/null
+++ b/src/scrolledwindow/gb-scrolled-window.c
@@ -0,0 +1,270 @@
+/* gb-scrolled-window.c
+ *
+ * Copyright (C) 2014 Christian Hergert <christian hergert me>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <glib/gi18n.h>
+
+#include "gb-scrolled-window.h"
+
+struct _GbScrolledWindowPrivate
+{
+  gint max_content_height;
+  gint max_content_width;
+};
+
+G_DEFINE_TYPE_WITH_PRIVATE (GbScrolledWindow, gb_scrolled_window,
+                            GTK_TYPE_SCROLLED_WINDOW)
+
+enum {
+  PROP_0,
+  PROP_MAX_CONTENT_HEIGHT,
+  PROP_MAX_CONTENT_WIDTH,
+  LAST_PROP
+};
+
+static GParamSpec *gParamSpecs [LAST_PROP];
+
+GtkWidget *
+gb_scrolled_window_new (void)
+{
+  return g_object_new (GB_TYPE_SCROLLED_WINDOW, NULL);
+}
+
+gint
+gb_scrolled_window_get_max_content_height (GbScrolledWindow *window)
+{
+  g_return_val_if_fail (GB_IS_SCROLLED_WINDOW (window), -1);
+
+  return window->priv->max_content_height;
+}
+
+/**
+ * gb_scrolled_window_set_max_content_height:
+ * @max_content_height: the max allowed height request or -1 to ignore.
+ *
+ * This function will set the "max-content-height" property. This property is
+ * used to determine the maximum height that the scrolled window will request.
+ *
+ * This is useful if you want to have a scrolled window grow with the child
+ * allocation, but only up to a certain height.
+ */
+void
+gb_scrolled_window_set_max_content_height (GbScrolledWindow *window,
+                                           gint              max_content_height)
+{
+  g_return_if_fail (GB_IS_SCROLLED_WINDOW (window));
+
+  if (max_content_height != window->priv->max_content_height)
+    {
+      window->priv->max_content_height = max_content_height;
+      g_object_notify_by_pspec (G_OBJECT (window),
+                                gParamSpecs [PROP_MAX_CONTENT_HEIGHT]);
+      gtk_widget_queue_resize (GTK_WIDGET (window));
+    }
+}
+
+gint
+gb_scrolled_window_get_max_content_width (GbScrolledWindow *window)
+{
+  g_return_val_if_fail (GB_IS_SCROLLED_WINDOW (window), -1);
+
+  return window->priv->max_content_width;
+}
+
+/**
+ * gb_scrolled_window_set_max_content_width:
+ * @max_content_width: the max allowed width request or -1 to ignore.
+ *
+ * This function will set the "max-content-width" property. This property is
+ * used to determine the maximum width that the scrolled window will request.
+ *
+ * This is useful if you want to have a scrolled window grow with the child
+ * allocation, but only up to a certain width.
+ */
+void
+gb_scrolled_window_set_max_content_width (GbScrolledWindow *window,
+                                          gint              max_content_width)
+{
+  g_return_if_fail (GB_IS_SCROLLED_WINDOW (window));
+
+  if (max_content_width != window->priv->max_content_width)
+    {
+      window->priv->max_content_width = max_content_width;
+      g_object_notify_by_pspec (G_OBJECT (window),
+                                gParamSpecs [PROP_MAX_CONTENT_HEIGHT]);
+      gtk_widget_queue_resize (GTK_WIDGET (window));
+    }
+}
+
+static void
+gb_scrolled_window_get_preferred_height (GtkWidget *widget,
+                                         gint      *minimum_height,
+                                         gint      *natural_height)
+{
+  GbScrolledWindow *self = (GbScrolledWindow *)widget;
+
+  g_return_if_fail (GB_IS_SCROLLED_WINDOW (self));
+
+  GTK_WIDGET_CLASS (gb_scrolled_window_parent_class)->
+    get_preferred_height (widget, minimum_height, natural_height);
+
+  if (natural_height)
+    {
+      if (self->priv->max_content_height > -1)
+        {
+          GtkWidget *child;
+          gint child_min_height;
+          gint child_nat_height;
+
+          child = gtk_bin_get_child (GTK_BIN (widget));
+          if (!child)
+            return;
+
+          gtk_widget_get_preferred_height (child, &child_min_height,
+                                           &child_nat_height);
+
+          if ((child_nat_height > *natural_height) &&
+              (self->priv->max_content_height > *natural_height))
+            *natural_height = MIN (self->priv->max_content_height,
+                                   child_nat_height);
+        }
+    }
+}
+
+static void
+gb_scrolled_window_get_preferred_width (GtkWidget *widget,
+                                        gint      *minimum_width,
+                                        gint      *natural_width)
+{
+  GbScrolledWindow *self = (GbScrolledWindow *)widget;
+
+  g_return_if_fail (GB_IS_SCROLLED_WINDOW (self));
+
+  GTK_WIDGET_CLASS (gb_scrolled_window_parent_class)->
+    get_preferred_width (widget, minimum_width, natural_width);
+
+  if (natural_width)
+    {
+      if (self->priv->max_content_width > -1)
+        {
+          GtkWidget *child;
+          gint child_min_width;
+          gint child_nat_width;
+
+          child = gtk_bin_get_child (GTK_BIN (widget));
+          if (!child)
+            return;
+
+          gtk_widget_get_preferred_width (child, &child_min_width,
+                                           &child_nat_width);
+
+          if ((child_nat_width > *natural_width) &&
+              (self->priv->max_content_width > *natural_width))
+            *natural_width = MIN (self->priv->max_content_width,
+                                   child_nat_width);
+        }
+    }
+}
+
+static void
+gb_scrolled_window_get_property (GObject    *object,
+                                 guint       prop_id,
+                                 GValue     *value,
+                                 GParamSpec *pspec)
+{
+  GbScrolledWindow *self = GB_SCROLLED_WINDOW (object);
+
+  switch (prop_id)
+    {
+    case PROP_MAX_CONTENT_HEIGHT:
+      g_value_set_int (value, gb_scrolled_window_get_max_content_height (self));
+      break;
+
+    case PROP_MAX_CONTENT_WIDTH:
+      g_value_set_int (value, gb_scrolled_window_get_max_content_width (self));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gb_scrolled_window_set_property (GObject      *object,
+                                 guint         prop_id,
+                                 const GValue *value,
+                                 GParamSpec   *pspec)
+{
+  GbScrolledWindow *self = GB_SCROLLED_WINDOW (object);
+
+  switch (prop_id)
+    {
+    case PROP_MAX_CONTENT_HEIGHT:
+      gb_scrolled_window_set_max_content_height (self, g_value_get_int (value));
+      break;
+
+    case PROP_MAX_CONTENT_WIDTH:
+      gb_scrolled_window_set_max_content_width (self, g_value_get_int (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gb_scrolled_window_class_init (GbScrolledWindowClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
+
+  object_class->get_property = gb_scrolled_window_get_property;
+  object_class->set_property = gb_scrolled_window_set_property;
+
+  widget_class->get_preferred_width = gb_scrolled_window_get_preferred_width;
+  widget_class->get_preferred_height = gb_scrolled_window_get_preferred_height;
+
+  gParamSpecs [PROP_MAX_CONTENT_HEIGHT] =
+    g_param_spec_int ("max-content-height",
+                      _("Max Content Height"),
+                      _("The maximum height request that can be made."),
+                      -1,
+                      G_MAXINT,
+                      -1,
+                      (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (object_class, PROP_MAX_CONTENT_HEIGHT,
+                                   gParamSpecs [PROP_MAX_CONTENT_HEIGHT]);
+
+  gParamSpecs [PROP_MAX_CONTENT_WIDTH] =
+    g_param_spec_int ("max-content-width",
+                      _("Max Content Width"),
+                      _("The maximum width request that can be made."),
+                      -1,
+                      G_MAXINT,
+                      -1,
+                      (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (object_class, PROP_MAX_CONTENT_WIDTH,
+                                   gParamSpecs [PROP_MAX_CONTENT_WIDTH]);
+}
+
+static void
+gb_scrolled_window_init (GbScrolledWindow *self)
+{
+  self->priv = gb_scrolled_window_get_instance_private (self);
+  self->priv->max_content_height = -1;
+  self->priv->max_content_width = -1;
+}
diff --git a/src/scrolledwindow/gb-scrolled-window.h b/src/scrolledwindow/gb-scrolled-window.h
new file mode 100644
index 0000000..4cc82c7
--- /dev/null
+++ b/src/scrolledwindow/gb-scrolled-window.h
@@ -0,0 +1,56 @@
+/* gb-scrolled-window.h
+ *
+ * Copyright (C) 2014 Christian Hergert <christian hergert me>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef GB_SCROLLED_WINDOW_H
+#define GB_SCROLLED_WINDOW_H
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+#define GB_TYPE_SCROLLED_WINDOW            (gb_scrolled_window_get_type())
+#define GB_SCROLLED_WINDOW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GB_TYPE_SCROLLED_WINDOW, 
GbScrolledWindow))
+#define GB_SCROLLED_WINDOW_CONST(obj)      (G_TYPE_CHECK_INSTANCE_CAST ((obj), GB_TYPE_SCROLLED_WINDOW, 
GbScrolledWindow const))
+#define GB_SCROLLED_WINDOW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  GB_TYPE_SCROLLED_WINDOW, 
GbScrolledWindowClass))
+#define GB_IS_SCROLLED_WINDOW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GB_TYPE_SCROLLED_WINDOW))
+#define GB_IS_SCROLLED_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  GB_TYPE_SCROLLED_WINDOW))
+#define GB_SCROLLED_WINDOW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  GB_TYPE_SCROLLED_WINDOW, 
GbScrolledWindowClass))
+
+typedef struct _GbScrolledWindow        GbScrolledWindow;
+typedef struct _GbScrolledWindowClass   GbScrolledWindowClass;
+typedef struct _GbScrolledWindowPrivate GbScrolledWindowPrivate;
+
+struct _GbScrolledWindow
+{
+  GtkScrolledWindow parent;
+
+  /*< private >*/
+  GbScrolledWindowPrivate *priv;
+};
+
+struct _GbScrolledWindowClass
+{
+  GtkScrolledWindowClass parent;
+};
+
+GType      gb_scrolled_window_get_type (void);
+GtkWidget *gb_scrolled_window_new      (void);
+
+G_END_DECLS
+
+#endif /* GB_SCROLLED_WINDOW_H */