[gtk/property-selection: 1/2] Add GtkPropertySelection
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/property-selection: 1/2] Add GtkPropertySelection
- Date: Sat, 6 Jun 2020 15:42:40 +0000 (UTC)
commit d1509971d8e3f7a953fcce952d93ccfc4387e391
Author: Matthias Clasen <mclasen redhat com>
Date: Sat Jun 6 09:40:04 2020 -0400
Add GtkPropertySelection
This is a selection model that stores the selection
state in a boolean property of the items, and thus
persists across reordering and similar changes.
Fixes: #2826
docs/reference/gtk/gtk4-docs.xml | 1 +
docs/reference/gtk/gtk4-sections.txt | 9 +
docs/reference/gtk/gtk4.types.in | 1 +
gtk/gtk.h | 1 +
gtk/gtkpropertyselection.c | 487 +++++++++++++++++++++++++++++++++++
gtk/gtkpropertyselection.h | 40 +++
gtk/meson.build | 2 +
testsuite/gtk/defaultvalue.c | 3 +
testsuite/gtk/notify.c | 4 +
testsuite/gtk/objects-finalize.c | 7 +-
10 files changed, 553 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/gtk/gtk4-docs.xml b/docs/reference/gtk/gtk4-docs.xml
index 792d3fb0bb..b6d09c9335 100644
--- a/docs/reference/gtk/gtk4-docs.xml
+++ b/docs/reference/gtk/gtk4-docs.xml
@@ -71,6 +71,7 @@
<xi:include href="xml/gtknoselection.xml" />
<xi:include href="xml/gtksingleselection.xml" />
<xi:include href="xml/gtkmultiselection.xml" />
+ <xi:include href="xml/gtkpropertyselection.xml" />
<xi:include href="xml/gtkdirectorylist.xml" />
</chapter>
diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index ddd8b58de3..70dbfca48d 100644
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -401,6 +401,15 @@ gtk_multi_selection_new
gtk_multi_selection_get_type
</SECTION>
+<SECTION>
+<FILE>gtkpropertyselection</FILE>
+<TITLE>GtkPropertySelection</TITLE>
+GtkPropertySelection
+gtk_property_selection_new
+<SUBSECTION Private>
+gtk_property_selection_get_type
+</SECTION>
+
<SECTION>
<FILE>gtklistitem</FILE>
<TITLE>GtkListItem</TITLE>
diff --git a/docs/reference/gtk/gtk4.types.in b/docs/reference/gtk/gtk4.types.in
index 446aa62004..472ec2846b 100644
--- a/docs/reference/gtk/gtk4.types.in
+++ b/docs/reference/gtk/gtk4.types.in
@@ -169,6 +169,7 @@ gtk_print_operation_preview_get_type
gtk_print_settings_get_type
@DISABLE_ON_W32@gtk_print_unix_dialog_get_type
gtk_progress_bar_get_type
+gtk_property_selection_get_type
gtk_radio_button_get_type
gtk_range_get_type
gtk_recent_manager_get_type
diff --git a/gtk/gtk.h b/gtk/gtk.h
index 5000638d44..055957d5e9 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -198,6 +198,7 @@
#include <gtk/gtkprintoperationpreview.h>
#include <gtk/gtkprintsettings.h>
#include <gtk/gtkprogressbar.h>
+#include <gtk/gtkpropertyselection.h>
#include <gtk/gtkradiobutton.h>
#include <gtk/gtkrange.h>
#include <gtk/gtkrecentmanager.h>
diff --git a/gtk/gtkpropertyselection.c b/gtk/gtkpropertyselection.c
new file mode 100644
index 0000000000..948e75ae2d
--- /dev/null
+++ b/gtk/gtkpropertyselection.c
@@ -0,0 +1,487 @@
+/*
+ * Copyright © 2020 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 <mclasen redhat com>
+ */
+
+#include "config.h"
+
+#include "gtkpropertyselection.h"
+
+#include "gtkintl.h"
+#include "gtkselectionmodel.h"
+
+/**
+ * SECTION:gtkpropertyselection
+ * @Short_description: A selection model that uses an item property
+ * @Title: GtkPropertySelection
+ * @see_also: #GtkSelectionModel
+ *
+ * GtkPropertySelection is an implementation of the #GtkSelectionModel
+ * interface that stores the selected state for each item in a property
+ * of the item.
+ *
+ * The property named by #GtkPropertySelection:property must be writable
+ * boolean property of the item type. GtkPropertySelection preserves the
+ * selected state of items when they are added to the model, but it does
+ * not listen to changes of the property while the item is a part of the
+ * model. It assumes that it has *exclusive* access to the property.
+ *
+ * The advantage of storing the selected state in item properties is that
+ * the state is *persistent* -- when an item is removed and re-added to
+ * the model, it will still have the same selection state. In particular,
+ * this makes the selection persist across changes of the sort order if
+ * the underlying model is a #GtkSortListModel.
+ */
+
+struct _GtkPropertySelection
+{
+ GObject parent_instance;
+
+ GListModel *model;
+ char *property;
+};
+
+struct _GtkPropertySelectionClass
+{
+ GObjectClass parent_class;
+};
+
+enum {
+ PROP_0,
+ PROP_MODEL,
+ PROP_PROPERTY,
+
+ N_PROPS,
+};
+
+static GParamSpec *properties[N_PROPS] = { NULL, };
+
+static GType
+gtk_property_selection_get_item_type (GListModel *list)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (list);
+
+ return g_list_model_get_item_type (self->model);
+}
+
+static guint
+gtk_property_selection_get_n_items (GListModel *list)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (list);
+
+ return g_list_model_get_n_items (self->model);
+}
+
+static gpointer
+gtk_property_selection_get_item (GListModel *list,
+ guint position)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (list);
+
+ return g_list_model_get_item (self->model, position);
+}
+
+static void
+gtk_property_selection_list_model_init (GListModelInterface *iface)
+{
+ iface->get_item_type = gtk_property_selection_get_item_type;
+ iface->get_n_items = gtk_property_selection_get_n_items;
+ iface->get_item = gtk_property_selection_get_item;
+}
+
+static gboolean
+is_selected (GtkPropertySelection *self,
+ guint position)
+{
+ gpointer item;
+ gboolean ret;
+
+ item = g_list_model_get_item (self->model, position);
+ g_object_get (item, self->property, &ret, NULL);
+ g_object_unref (item);
+
+ return ret;
+}
+
+static void
+set_selected (GtkPropertySelection *self,
+ guint position,
+ gboolean selected)
+{
+ gpointer item;
+
+ item = g_list_model_get_item (self->model, position);
+ g_object_set (item, self->property, selected, NULL);
+ g_object_unref (item);
+}
+
+static gboolean
+gtk_property_selection_is_selected (GtkSelectionModel *model,
+ guint position)
+{
+ return is_selected (GTK_PROPERTY_SELECTION (model), position);
+}
+
+static gboolean
+gtk_property_selection_select_range (GtkSelectionModel *model,
+ guint position,
+ guint n_items,
+ gboolean exclusive)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (model);
+ guint i;
+ guint n;
+
+ n = g_list_model_get_n_items (G_LIST_MODEL (self));
+ if (exclusive)
+ {
+ for (i = 0; i < n; i++)
+ set_selected (self, i, FALSE);
+ }
+
+ for (i = position; i < position + n_items; i++)
+ set_selected (self, i, TRUE);
+
+ /* FIXME: do better here */
+ if (exclusive)
+ gtk_selection_model_selection_changed (model, 0, n);
+ else
+ gtk_selection_model_selection_changed (model, position, n_items);
+
+ return TRUE;
+}
+
+static gboolean
+gtk_property_selection_unselect_range (GtkSelectionModel *model,
+ guint position,
+ guint n_items)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (model);
+ guint i;
+
+ for (i = position; i < position + n_items; i++)
+ set_selected (self, i, FALSE);
+
+ gtk_selection_model_selection_changed (model, position, n_items);
+
+ return TRUE;
+}
+
+static gboolean
+gtk_property_selection_select_item (GtkSelectionModel *model,
+ guint position,
+ gboolean exclusive)
+{
+ return gtk_property_selection_select_range (model, position, 1, exclusive);
+}
+
+static gboolean
+gtk_property_selection_unselect_item (GtkSelectionModel *model,
+ guint position)
+{
+ return gtk_property_selection_unselect_range (model, position, 1);
+}
+
+static gboolean
+gtk_property_selection_select_all (GtkSelectionModel *model)
+{
+ return gtk_property_selection_select_range (model, 0, g_list_model_get_n_items (G_LIST_MODEL (model)),
FALSE);
+}
+
+static gboolean
+gtk_property_selection_unselect_all (GtkSelectionModel *model)
+{
+ return gtk_property_selection_unselect_range (model, 0, g_list_model_get_n_items (G_LIST_MODEL (model)));
+}
+
+static gboolean
+gtk_property_selection_add_or_remove (GtkSelectionModel *model,
+ gboolean add,
+ GtkSelectionCallback callback,
+ gpointer data)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (model);
+ guint pos, start, n;
+ gboolean in;
+ guint min, max;
+ guint i;
+
+ min = G_MAXUINT;
+ max = 0;
+
+ pos = 0;
+ do
+ {
+ callback (pos, &start, &n, &in, data);
+ if (in)
+ {
+ if (start < min)
+ min = start;
+ if (start + n - 1 > max)
+ max = start + n - 1;
+
+ for (i = start; i < start + n; i++)
+ set_selected (self, i, add);
+ }
+ pos = start + n;
+ }
+ while (n > 0);
+
+ if (min <= max)
+ gtk_selection_model_selection_changed (model, min, max - min + 1);
+
+ return TRUE;
+}
+
+static gboolean
+gtk_property_selection_select_callback (GtkSelectionModel *model,
+ GtkSelectionCallback callback,
+ gpointer data)
+{
+ return gtk_property_selection_add_or_remove (model, TRUE, callback, data);
+}
+
+static gboolean
+gtk_property_selection_unselect_callback (GtkSelectionModel *model,
+ GtkSelectionCallback callback,
+ gpointer data)
+{
+ return gtk_property_selection_add_or_remove (model, FALSE, callback, data);
+}
+
+static void
+gtk_property_selection_query_range (GtkSelectionModel *model,
+ guint position,
+ guint *start_range,
+ guint *n_items,
+ gboolean *selected)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (model);
+ guint n;
+ gboolean sel;
+ guint start, end;
+
+ n = g_list_model_get_n_items (G_LIST_MODEL (self));
+ sel = is_selected (self, position);
+
+ start = position;
+ while (start > 0)
+ {
+ if (is_selected (self, start - 1) != sel)
+ break;
+ start--;
+ }
+
+ end = position;
+ while (end + 1 < n)
+ {
+ if (is_selected (self, end + 1) != sel)
+ break;
+ end++;
+ }
+
+ *start_range = start;
+ *n_items = end - start + 1;
+ *selected = sel;
+}
+
+static void
+gtk_property_selection_selection_model_init (GtkSelectionModelInterface *iface)
+{
+ iface->is_selected = gtk_property_selection_is_selected;
+ iface->select_item = gtk_property_selection_select_item;
+ iface->unselect_item = gtk_property_selection_unselect_item;
+ iface->select_range = gtk_property_selection_select_range;
+ iface->unselect_range = gtk_property_selection_unselect_range;
+ iface->select_all = gtk_property_selection_select_all;
+ iface->unselect_all = gtk_property_selection_unselect_all;
+ iface->select_callback = gtk_property_selection_select_callback;
+ iface->unselect_callback = gtk_property_selection_unselect_callback;
+ iface->query_range = gtk_property_selection_query_range;
+}
+
+G_DEFINE_TYPE_EXTENDED (GtkPropertySelection, gtk_property_selection, G_TYPE_OBJECT, 0,
+ G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL,
+ gtk_property_selection_list_model_init)
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_SELECTION_MODEL,
+ gtk_property_selection_selection_model_init))
+
+static void
+gtk_property_selection_items_changed_cb (GListModel *model,
+ guint position,
+ guint removed,
+ guint added,
+ GtkPropertySelection *self)
+{
+ g_list_model_items_changed (G_LIST_MODEL (self), position, removed, added);
+}
+
+static void
+gtk_property_selection_clear_model (GtkPropertySelection *self)
+{
+ if (self->model == NULL)
+ return;
+
+ g_signal_handlers_disconnect_by_func (self->model,
+ gtk_property_selection_items_changed_cb,
+ self);
+ g_clear_object (&self->model);
+}
+
+static void
+gtk_property_selection_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (object);
+
+ switch (prop_id)
+ {
+ case PROP_MODEL:
+ self->model = g_value_dup_object (value);
+ g_warn_if_fail (self->model != NULL);
+ g_signal_connect (self->model,
+ "items-changed",
+ G_CALLBACK (gtk_property_selection_items_changed_cb),
+ self);
+ break;
+
+ case PROP_PROPERTY:
+ {
+ GObjectClass *class;
+ GParamSpec *prop;
+
+ self->property = g_value_dup_string (value);
+ g_warn_if_fail (self->property != NULL);
+
+ class = g_type_class_ref (g_list_model_get_item_type (self->model));
+ prop = g_object_class_find_property (class, self->property);
+ g_warn_if_fail (prop != NULL &&
+ prop->value_type == G_TYPE_BOOLEAN &&
+ ((prop->flags & (G_PARAM_READABLE|G_PARAM_WRITABLE|G_PARAM_CONSTRUCT_ONLY)) ==
+ (G_PARAM_READABLE|G_PARAM_WRITABLE)));
+ g_type_class_unref (class);
+ }
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gtk_property_selection_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (object);
+
+ switch (prop_id)
+ {
+ case PROP_MODEL:
+ g_value_set_object (value, self->model);
+ break;
+
+ case PROP_PROPERTY:
+ g_value_set_string (value, self->property);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gtk_property_selection_dispose (GObject *object)
+{
+ GtkPropertySelection *self = GTK_PROPERTY_SELECTION (object);
+
+ gtk_property_selection_clear_model (self);
+
+ g_free (self->property);
+
+ G_OBJECT_CLASS (gtk_property_selection_parent_class)->dispose (object);
+}
+
+static void
+gtk_property_selection_class_init (GtkPropertySelectionClass *klass)
+{
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+ gobject_class->get_property = gtk_property_selection_get_property;
+ gobject_class->set_property = gtk_property_selection_set_property;
+ gobject_class->dispose = gtk_property_selection_dispose;
+
+ /**
+ * GtkPropertySelection:model
+ *
+ * The list managed by this selection
+ */
+ properties[PROP_MODEL] =
+ g_param_spec_object ("model",
+ P_("Model"),
+ P_("List managed by this selection"),
+ G_TYPE_LIST_MODEL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_EXPLICIT_NOTIFY |
G_PARAM_STATIC_STRINGS);
+
+ properties[PROP_PROPERTY] =
+ g_param_spec_string ("property",
+ P_("Property"),
+ P_("Item property to store selection state in"),
+ NULL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_EXPLICIT_NOTIFY |
G_PARAM_STATIC_STRINGS);
+
+ g_object_class_install_properties (gobject_class, N_PROPS, properties);
+}
+
+static void
+gtk_property_selection_init (GtkPropertySelection *self)
+{
+}
+
+/**
+ * gtk_property_selection_new:
+ * @model: (transfer none): the #GListModel to manage
+ * @property: the item property to use
+ *
+ * Creates a new property selection to handle @model.
+ *
+ * @property must be the name of a writable boolean property
+ * of the item type of @model.
+ *
+ * Note that GtkPropertySelection does not monitor the property
+ * for changes while the item is part of the model, but it does
+ * inherit the initial value when an item is added to the model.
+ *
+ * Returns: (transfer full) (type GtkPropertySelection): a new #GtkPropertySelection
+ **/
+GListModel *
+gtk_property_selection_new (GListModel *model,
+ const char *property)
+{
+ g_return_val_if_fail (G_IS_LIST_MODEL (model), NULL);
+
+ return g_object_new (GTK_TYPE_PROPERTY_SELECTION,
+ "model", model,
+ "property", property,
+ NULL);
+}
diff --git a/gtk/gtkpropertyselection.h b/gtk/gtkpropertyselection.h
new file mode 100644
index 0000000000..60378ae655
--- /dev/null
+++ b/gtk/gtkpropertyselection.h
@@ -0,0 +1,40 @@
+/*
+ * Copyright © 2019 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 <mclasen redhat com>
+ */
+
+#ifndef __GTK_PROPERTY_SELECTION_H__
+#define __GTK_PROPERTY_SELECTION_H__
+
+#include <gtk/gtktypes.h>
+#include <gtk/gtkselectionmodel.h>
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_PROPERTY_SELECTION (gtk_property_selection_get_type ())
+
+GDK_AVAILABLE_IN_ALL
+G_DECLARE_FINAL_TYPE (GtkPropertySelection, gtk_property_selection, GTK, PROPERTY_SELECTION, GObject)
+
+GDK_AVAILABLE_IN_ALL
+GListModel * gtk_property_selection_new (GListModel *model,
+ const char *property);
+
+
+G_END_DECLS
+
+#endif /* __GTK_PROPERTY_SELECTION_H__ */
diff --git a/gtk/meson.build b/gtk/meson.build
index 2ca67edcbd..4f02dbc4c7 100644
--- a/gtk/meson.build
+++ b/gtk/meson.build
@@ -327,6 +327,7 @@ gtk_public_sources = files([
'gtkprintsettings.c',
'gtkprogressbar.c',
'gtkpropertylookuplistmodel.c',
+ 'gtkpropertyselection.c',
'gtkradiobutton.c',
'gtkrange.c',
'gtktreerbtree.c',
@@ -600,6 +601,7 @@ gtk_public_headers = files([
'gtkprintoperationpreview.h',
'gtkprintsettings.h',
'gtkprogressbar.h',
+ 'gtkpropertyselection.h',
'gtkradiobutton.h',
'gtkrange.h',
'gtkrecentmanager.h',
diff --git a/testsuite/gtk/defaultvalue.c b/testsuite/gtk/defaultvalue.c
index 1d555e1304..79fa0050e4 100644
--- a/testsuite/gtk/defaultvalue.c
+++ b/testsuite/gtk/defaultvalue.c
@@ -104,6 +104,9 @@ test_type (gconstpointer data)
g_type_is_a (type, GTK_TYPE_SHORTCUT_ACTION))
return;
+ if (g_type_is_a (type, GTK_TYPE_PROPERTY_SELECTION))
+ return;
+
klass = g_type_class_ref (type);
if (g_type_is_a (type, GTK_TYPE_SETTINGS))
diff --git a/testsuite/gtk/notify.c b/testsuite/gtk/notify.c
index ddd806948d..209685ed38 100644
--- a/testsuite/gtk/notify.c
+++ b/testsuite/gtk/notify.c
@@ -425,6 +425,10 @@ test_type (gconstpointer data)
g_type_is_a (type, GTK_TYPE_NAMED_ACTION))
return;
+ /* needs special item type in underlying model */
+ if (g_type_is_a (type, GTK_TYPE_PROPERTY_SELECTION))
+ return;
+
klass = g_type_class_ref (type);
if (g_type_is_a (type, GTK_TYPE_SETTINGS))
diff --git a/testsuite/gtk/objects-finalize.c b/testsuite/gtk/objects-finalize.c
index ef5223b923..fe26c31d37 100644
--- a/testsuite/gtk/objects-finalize.c
+++ b/testsuite/gtk/objects-finalize.c
@@ -80,9 +80,12 @@ test_finalize_object (gconstpointer data)
NULL);
g_object_unref (list_store);
}
- else if (g_type_is_a (test_type, GTK_TYPE_LAYOUT_CHILD))
+ else if (g_type_is_a (test_type, GTK_TYPE_LAYOUT_CHILD) ||
+ g_type_is_a (test_type, GTK_TYPE_PROPERTY_SELECTION))
{
- g_test_skip ("Skipping GtkLayoutChild type");
+ char *msg = g_strdup_printf ("Skipping %s", g_type_name (test_type));
+ g_test_skip (msg);
+ g_free (msg);
return;
}
else
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
