Add GtkDropDown

This is a simple drop down control using list models.

docs/reference/gtk/gtk4-docs.xml

@@ -86,6 +86,7 @@
       <xi:include href="xml/gtkgridview.xml" />
       <xi:include href="xml/gtkcolumnview.xml" />
       <xi:include href="xml/gtkcolumnviewcolumn.xml" />
+      <xi:include href="xml/gtkdropdown.xml" />
     </chapter>
 
     <chapter id="Trees">
@@ -258,6 +259,7 @@
       <xi:include href="xml/gtkpopover.xml" />
       <xi:include href="xml/gtkpopovermenu.xml" />
       <xi:include href="xml/gtkpopovermenubar.xml" />
+      <xi:include href="xml/gtkdropdown.xml" />
     </chapter>
 
     <chapter id="SelectorWidgets">

docs/reference/gtk/gtk4-sections.txt

@@ -7443,3 +7443,27 @@ gtk_string_filter_set_match_mode
 <SUBSECTION Private>
 gtk_string_filter_get_type
 </SECTION>
+
+<SECTION>
+<FILE>gtkdropdown</FILE>
+<TITLE>GtkDropDown</TITLE>
+GtkDropDown
+gtk_drop_down_new
+gtk_drop_down_set_from_strings
+gtk_drop_down_set_model
+gtk_drop_down_get_model
+gtk_drop_down_set_selected
+gtk_drop_down_get_selected
+gtk_drop_down_set_factory
+gtk_drop_down_get_factory
+gtk_drop_down_set_list_factory
+gtk_drop_down_get_list_factory
+gtk_drop_down_set_expression
+gtk_drop_down_get_expression
+gtk_drop_down_set_enable_search
+gtk_drop_down_get_enable_search
+<SUBSECTION Standard>
+GTK_TYPE_DROP_DOWN
+<SUBSECTION Private>
+gtk_drop_down_get_type
+</SECTION>

docs/reference/gtk/gtk4.types.in

@@ -66,6 +66,7 @@ gtk_drag_source_get_type
 gtk_drawing_area_get_type
 gtk_drop_target_get_type
 gtk_drop_target_async_get_type
+gtk_drop_down_get_type
 gtk_editable_get_type
 gtk_emoji_chooser_get_type
 gtk_entry_buffer_get_type

gtk/gtk.h

@@ -98,6 +98,7 @@
 #include <gtk/gtkdropcontrollermotion.h>
 #include <gtk/gtkdroptarget.h>
 #include <gtk/gtkdroptargetasync.h>
+#include <gtk/gtkdropdown.h>
 #include <gtk/gtkeditable.h>
 #include <gtk/gtkemojichooser.h>
 #include <gtk/gtkentry.h>

gtk/gtkdropdown.h

@@ -0,0 +1,80 @@
+/*
+ * Copyright © 2018 Red Hat, Inc.
+ *
+ * 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.1 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, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors: Matthias Clasen
+ */
+
+#ifndef __GTK_DROP_DOWN_H__
+#define __GTK_DROP_DOWN_H__
+
+#include <gtk/gtkwidget.h>
+#include <gtk/gtkexpression.h>
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_DROP_DOWN         (gtk_drop_down_get_type ())
+
+GDK_AVAILABLE_IN_ALL
+G_DECLARE_FINAL_TYPE (GtkDropDown, gtk_drop_down, GTK, DROP_DOWN, GtkWidget)
+
+GDK_AVAILABLE_IN_ALL
+GtkWidget *     gtk_drop_down_new                               (void);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_from_strings                  (GtkDropDown            *self,
+                                                                 const char *const      *texts);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_model                         (GtkDropDown            *self,
+                                                                 GListModel             *model);
+GDK_AVAILABLE_IN_ALL
+GListModel *    gtk_drop_down_get_model                         (GtkDropDown            *self);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_selected                      (GtkDropDown            *self,
+                                                                 guint                   position);
+GDK_AVAILABLE_IN_ALL
+guint           gtk_drop_down_get_selected                      (GtkDropDown            *self);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_factory                       (GtkDropDown            *self,
+                                                                 GtkListItemFactory     *factory);
+GDK_AVAILABLE_IN_ALL
+GtkListItemFactory *
+                gtk_drop_down_get_factory                       (GtkDropDown            *self);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_list_factory                  (GtkDropDown            *self,
+                                                                 GtkListItemFactory     *factory);
+GDK_AVAILABLE_IN_ALL
+GtkListItemFactory *
+                gtk_drop_down_get_list_factory                  (GtkDropDown            *self);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_expression                    (GtkDropDown            *self,
+                                                                 GtkExpression          *expression);
+GDK_AVAILABLE_IN_ALL
+GtkExpression * gtk_drop_down_get_expression                    (GtkDropDown            *self);
+
+GDK_AVAILABLE_IN_ALL
+void            gtk_drop_down_set_enable_search                 (GtkDropDown            *self,
+                                                                 gboolean                enable_search);
+GDK_AVAILABLE_IN_ALL
+gboolean        gtk_drop_down_get_enable_search                 (GtkDropDown            *self);
+
+G_END_DECLS
+
+#endif  /* __GTK_DROP_DOWN_H__ */

gtk/meson.build

@@ -219,6 +219,7 @@ gtk_public_sources = files([
   'gtkdropcontrollermotion.c',
   'gtkdroptarget.c',
   'gtkdroptargetasync.c',
+  'gtkdropdown.c',
   'gtkeditable.c',
   'gtkemojichooser.c',
   'gtkemojicompletion.c',
@@ -499,6 +500,7 @@ gtk_public_headers = files([
   'gtkdropcontrollermotion.h',
   'gtkdroptarget.h',
   'gtkdroptargetasync.h',
+  'gtkdropdown.h',
   'gtkeditable.h',
   'gtkemojichooser.h',
   'gtkentry.h',

gtk/ui/gtkdropdown.ui

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface domain="gtk40">
+  <template class="GtkDropDown" parent="GtkWidget">
+    <child>
+      <object class="GtkToggleButton" id="button">
+        <signal name="toggled" handler="button_toggled"/>
+        <child>
+          <object class="GtkBox">
+            <property name="can-focus">0</property>
+            <child>
+              <object class="GtkStack" id="button_stack">
+                <property name="halign">fill</property>
+                <property name="hexpand">1</property>
+                <child>
+                  <object class="GtkStackPage">
+                    <property name="name">empty</property>
+                    <property name="child">
+                      <object class="GtkLabel">
+                        <property name="label" translatable="yes">(None)</property>
+                        <property name="xalign">0</property>
+                      </object>
+                    </property>
+                  </object>
+                </child>
+                <child>
+                  <object class="GtkStackPage">
+                    <property name="name">item</property>
+                    <property name="child">
+                      <object class="GtkListItemWidget" id="button_item"/>
+                    </property>
+                  </object>
+                </child>
+              </object>
+            </child>
+            <child>
+              <object class="GtkBuiltinIcon">
+                <property name="css-name">arrow</property>
+              </object>
+            </child>
+          </object>
+        </child>
+      </object>
+    </child>
+    <child>
+  <object class="GtkPopover" id="popup">
+    <signal name="closed" handler="popover_closed"/>
+    <property name="has-arrow">0</property>
+    <property name="autohide">1</property>
+    <child>
+      <object class="GtkBox">
+        <property name="orientation">vertical</property>
+        <child>
+          <object class="GtkSearchEntry" id="search_entry">
+            <signal name="search-changed" handler="search_changed"/>
+            <property name="visible">0</property>
+            <property name="placeholder-text" translatable="yes">Search…</property>
+          </object>
+        </child>
+        <child>
+          <object class="GtkScrolledWindow">
+            <property name="hscrollbar-policy">never</property>
+            <property name="vscrollbar-policy">automatic</property>
+            <property name="max-content-height">400</property>
+            <property name="propagate-natural-height">1</property>
+            <child>
+              <object class="GtkListView" id="popup_list">
+                <signal name="activate" handler="row_activated"/>
+                <property name="single-click-activate">1</property>
+              </object>
+            </child>
+          </object>
+        </child>
+      </object>
+    </child>
+  </object>
+  </child>
+  </template>
+</interface>

tests/meson.build

@@ -1,5 +1,6 @@
 gtk_tests = [
   # testname, optional extra sources
+  ['testdropdown'],
   ['rendernode'],
   ['rendernode-create-tests'],
   ['overlayscroll'],

tests/testdropdown.c

@@ -0,0 +1,321 @@
+/* simple.c
+ * Copyright (C) 2017  Red Hat, Inc
+ * Author: Benjamin Otte
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <gtk/gtk.h>
+
+
+#define STRING_TYPE_HOLDER (string_holder_get_type ())
+G_DECLARE_FINAL_TYPE (StringHolder, string_holder, STRING, HOLDER, GObject)
+
+struct _StringHolder {
+  GObject parent_instance;
+  char *title;
+  char *icon;
+  char *description;
+};
+
+G_DEFINE_TYPE (StringHolder, string_holder, G_TYPE_OBJECT);
+
+static void
+string_holder_init (StringHolder *holder)
+{
+}
+
+static void
+string_holder_finalize (GObject *object)
+{
+  StringHolder *holder = STRING_HOLDER (object);
+
+  g_free (holder->title);
+  g_free (holder->icon);
+  g_free (holder->description);
+
+  G_OBJECT_CLASS (string_holder_parent_class)->finalize (object);
+}
+
+static void
+string_holder_class_init (StringHolderClass *class)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+  object_class->finalize = string_holder_finalize;
+}
+
+static StringHolder *
+string_holder_new (const char *title, const char *icon, const char *description)
+{
+  StringHolder *holder = g_object_new (STRING_TYPE_HOLDER, NULL);
+  holder->title = g_strdup (title);
+  holder->icon = g_strdup (icon);
+  holder->description = g_strdup (description);
+  return holder;
+}
+
+static void
+strings_setup_item_single_line (GtkSignalListItemFactory *factory,
+                                GtkListItem              *item)
+{
+  GtkWidget *box, *image, *title;
+
+  box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 10);
+
+  image = gtk_image_new ();
+  title = gtk_label_new ("");
+  gtk_label_set_xalign (GTK_LABEL (title), 0.0);
+
+  gtk_box_append (GTK_BOX (box), image);
+  gtk_box_append (GTK_BOX (box), title);
+
+  g_object_set_data (G_OBJECT (item), "title", title);
+  g_object_set_data (G_OBJECT (item), "image", image);
+
+  gtk_list_item_set_child (item, box);
+}
+
+static void
+strings_setup_item_full (GtkSignalListItemFactory *factory,
+                         GtkListItem              *item)
+{
+  GtkWidget *box, *box2, *image, *title, *description;
+
+  image = gtk_image_new ();
+  title = gtk_label_new ("");
+  gtk_label_set_xalign (GTK_LABEL (title), 0.0);
+  description = gtk_label_new ("");
+  gtk_label_set_xalign (GTK_LABEL (description), 0.0);
+  gtk_style_context_add_class (gtk_widget_get_style_context (description), "dim-label");
+
+  box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 10);
+  box2 = gtk_box_new (GTK_ORIENTATION_VERTICAL, 2);
+
+  gtk_box_append (GTK_BOX (box), image);
+  gtk_box_append (GTK_BOX (box), box2);
+  gtk_box_append (GTK_BOX (box2), title);
+  gtk_box_append (GTK_BOX (box2), description);
+
+  g_object_set_data (G_OBJECT (item), "title", title);
+  g_object_set_data (G_OBJECT (item), "image", image);
+  g_object_set_data (G_OBJECT (item), "description", description);
+
+  gtk_list_item_set_child (item, box);
+}
+
+static void
+strings_bind_item (GtkSignalListItemFactory *factory,
+                    GtkListItem              *item)
+{
+  GtkWidget *image, *title, *description;
+  StringHolder *holder;
+
+  holder = gtk_list_item_get_item (item);
+
+  title = g_object_get_data (G_OBJECT (item), "title");
+  image = g_object_get_data (G_OBJECT (item), "image");
+  description = g_object_get_data (G_OBJECT (item), "description");
+
+  gtk_label_set_label (GTK_LABEL (title), holder->title);
+  if (image)
+    {
+      gtk_image_set_from_icon_name (GTK_IMAGE (image), holder->icon);
+      gtk_widget_set_visible (image, holder->icon != NULL);
+    }
+  if (description)
+    {
+      gtk_label_set_label (GTK_LABEL (description), holder->description);
+      gtk_widget_set_visible (description , holder->description != NULL);        
+    }
+}
+
+static GtkListItemFactory *
+strings_factory_new (gboolean full)
+{
+  GtkListItemFactory *factory;
+
+  factory = gtk_signal_list_item_factory_new ();
+  if (full)
+    g_signal_connect (factory, "setup", G_CALLBACK (strings_setup_item_full), NULL);
+  else
+    g_signal_connect (factory, "setup", G_CALLBACK (strings_setup_item_single_line), NULL);
+  g_signal_connect (factory, "bind", G_CALLBACK (strings_bind_item), NULL);
+
+  return factory;
+}
+
+static GListModel *
+strings_model_new (const char *const *titles,
+                   const char *const *icons,
+                   const char *const *descriptions)
+{
+  GListStore *store;
+  int i;
+
+  store = g_list_store_new (STRING_TYPE_HOLDER);
+  for (i = 0; titles[i]; i++)
+    {
+      StringHolder *holder = string_holder_new (titles[i],
+                                                icons ? icons[i] : NULL,
+                                                descriptions ? descriptions[i] : NULL);
+      g_list_store_append (store, holder);
+      g_object_unref (holder);
+    }
+
+  return G_LIST_MODEL (store);
+}
+
+static GtkWidget *
+drop_down_new_from_strings (const char *const *titles,
+                            const char *const *icons,
+                            const char *const *descriptions)
+{
+  GtkWidget *widget;
+  GListModel *model;
+  GtkListItemFactory *factory;
+  GtkListItemFactory *list_factory;
+
+  g_return_val_if_fail (titles != NULL, NULL);
+  g_return_val_if_fail (icons == NULL || g_strv_length ((char **)icons) == g_strv_length ((char **)titles), NULL);
+  g_return_val_if_fail (descriptions == NULL || g_strv_length ((char **)icons) == g_strv_length ((char **)descriptions), NULL);
+
+  model = strings_model_new (titles, icons, descriptions);
+  factory = strings_factory_new (FALSE);
+  if (icons != NULL || descriptions != NULL)
+    list_factory = strings_factory_new (TRUE);
+  else
+    list_factory = NULL;
+
+  widget = g_object_new (GTK_TYPE_DROP_DOWN,
+                         "model", model,
+                         "factory", factory,
+                         "list-factory", list_factory,
+                         NULL);
+
+  g_object_unref (model);
+  g_object_unref (factory);
+  if (list_factory)
+    g_object_unref (list_factory);
+
+  return widget;
+}
+
+static char *
+get_family_name (gpointer item)
+{
+  return g_strdup (pango_font_family_get_name (PANGO_FONT_FAMILY (item)));
+}
+
+static char *
+get_title (gpointer item)
+{
+  return g_strdup (STRING_HOLDER (item)->title);
+}
+
+static gboolean
+quit_cb (GtkWindow *window,
+         gpointer   data)
+{
+  *((gboolean*)data) = TRUE;
+
+  g_main_context_wakeup (NULL);
+
+  return TRUE;
+}
+
+int
+main (int argc, char *argv[])
+{
+  GtkWidget *window, *button, *box, *spin, *check;
+  GListModel *model;
+  GtkExpression *expression;
+  const char * const times[] = { "1 minute", "2 minutes", "5 minutes", "20 minutes", NULL };
+  const char * const many_times[] = {
+    "1 minute", "2 minutes", "5 minutes", "10 minutes", "15 minutes", "20 minutes",
+    "25 minutes", "30 minutes", "35 minutes", "40 minutes", "45 minutes", "50 minutes",
+    "55 minutes", "1 hour", "2 hours", "3 hours", "5 hours", "6 hours", "7 hours",
+    "8 hours", "9 hours", "10 hours", "11 hours", "12 hours", NULL
+  };
+  const char * const device_titles[] = { "Digital Output", "Headphones", "Digital Output", "Analog Output", NULL };
+  const char * const device_icons[] = {  "audio-card-symbolic", "audio-headphones-symbolic", "audio-card-symbolic", "audio-card-symbolic", NULL };
+  const char * const device_descriptions[] = {
+    "Built-in Audio", "Built-in audio", "Thinkpad Tunderbolt 3 Dock USB Audio", "Thinkpad Tunderbolt 3 Dock USB Audio", NULL
+  };
+  gboolean quit = FALSE;
+
+  gtk_init ();
+
+  window = gtk_window_new ();
+  gtk_window_set_title (GTK_WINDOW (window), "hello world");
+  gtk_window_set_resizable (GTK_WINDOW (window), TRUE);
+  g_signal_connect (window, "close-request", G_CALLBACK (quit_cb), &quit);
+
+  box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 10);
+  gtk_widget_set_margin_start (box, 10);
+  gtk_widget_set_margin_end (box, 10);
+  gtk_widget_set_margin_top (box, 10);
+  gtk_widget_set_margin_bottom (box, 10);
+  gtk_window_set_child (GTK_WINDOW (window), box);
+
+  button = gtk_drop_down_new ();
+
+  model = G_LIST_MODEL (pango_cairo_font_map_get_default ());
+  gtk_drop_down_set_model (GTK_DROP_DOWN (button), model);
+  gtk_drop_down_set_selected (GTK_DROP_DOWN (button), 0);
+
+  expression = gtk_cclosure_expression_new (G_TYPE_STRING, NULL,
+                                            0, NULL,
+                                            (GCallback)get_family_name,
+                                            NULL, NULL);
+  gtk_drop_down_set_expression (GTK_DROP_DOWN (button), expression);
+  gtk_expression_unref (expression);
+  gtk_box_append (GTK_BOX (box), button);
+
+  spin = gtk_spin_button_new_with_range (-1, g_list_model_get_n_items (G_LIST_MODEL (model)), 1);
+  gtk_widget_set_halign (spin, GTK_ALIGN_START);
+  g_object_bind_property  (button, "selected", spin, "value", G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
+  gtk_box_append (GTK_BOX (box), spin);
+
+  check = gtk_check_button_new_with_label ("Enable search");
+  g_object_bind_property  (button, "enable-search", check, "active", G_BINDING_SYNC_CREATE | G_BINDING_BIDIRECTIONAL);
+  gtk_box_append (GTK_BOX (box), check);
+
+  g_object_unref (model);
+
+  button = drop_down_new_from_strings (times, NULL, NULL);
+  gtk_box_append (GTK_BOX (box), button);
+
+  button = drop_down_new_from_strings (many_times, NULL, NULL);
+  gtk_box_append (GTK_BOX (box), button);
+
+  button = drop_down_new_from_strings (many_times, NULL, NULL);
+  gtk_drop_down_set_enable_search (GTK_DROP_DOWN (button), TRUE);
+  expression = gtk_cclosure_expression_new (G_TYPE_STRING, NULL,
+                                            0, NULL,
+                                            (GCallback)get_title,
+                                            NULL, NULL);
+  gtk_drop_down_set_expression (GTK_DROP_DOWN (button), expression);
+  gtk_expression_unref (expression);
+  gtk_box_append (GTK_BOX (box), button);
+
+  button = drop_down_new_from_strings (device_titles, device_icons, device_descriptions);
+  gtk_box_append (GTK_BOX (box), button);
+
+  gtk_window_present (GTK_WINDOW (window));
+
+  while (!quit)
+    g_main_context_iteration (NULL, TRUE);
+
+  return 0;
+}

testsuite/gtk/defaultvalue.c

@@ -411,6 +411,10 @@ G_GNUC_END_IGNORE_DEPRECATIONS
           strcmp (pspec->name, "adjustment") == 0)
         continue;
 
+      if (g_type_is_a (type, GTK_TYPE_DROP_DOWN) &&
+          strcmp (pspec->name, "factory") == 0)
+        continue;
+
       /* All the icontheme properties depend on the environment */
       if (g_type_is_a (type, GTK_TYPE_ICON_THEME))
         continue;

testsuite/gtk/notify.c

@@ -647,6 +647,11 @@ test_type (gconstpointer data)
             g_str_equal (pspec->name, "selected-item")))
          continue;
 
+       /* can't select items without an underlying, populated model */
+       if (g_type_is_a (type, GTK_TYPE_DROP_DOWN) &&
+           g_str_equal (pspec->name, "selected"))
+         continue;
+
        /* can't set position without a notebook */
        if (g_type_is_a (type, GTK_TYPE_NOTEBOOK_PAGE) &&
            g_str_equal (pspec->name, "position"))