Gimp/libgimpwidgets/gimplabelintwidget.c
Jehan 7b6f2e5c2b libgimp, libgimpwidgets, plug-ins: improved GimpProcedureDialog API.
- New GimpLabelIntWidget which is a label associated to any widget with
  an integer "value" property.
- New gimp_procedure_dialog_get_int_combo() which creates a labeled
  combo box from an integer property of the GimpProcedureConfig.
- Renamed gimp_procedure_dialog_populate*() with
  gimp_procedure_dialog_fill*(). Naming is hard! I hesitated using
  _pack() as well (similarly to GtkBox API).
- New gimp_procedure_dialog_fill_flowbox*() functions to create a
  GtkFlowBox filled with property widgets (or other container widgets as
  we can pack them one in another). This is an alternative way to build
  your GUI with sane defaults, with list of property names.
2020-11-13 21:27:56 +01:00

252 lines
8.3 KiB
C

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimplabelintwidget.c
* Copyright (C) 2020 Jehan
*
* 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 3 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 Lesser General Public
* License along with this library. If not, see
* <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include <gegl.h>
#include <gtk/gtk.h>
#include "libgimpcolor/gimpcolor.h"
#include "libgimpmath/gimpmath.h"
#include "libgimpbase/gimpbase.h"
#include "gimplabelintwidget.h"
/**
* SECTION: gimplabelintwidget
* @title: GimpLabelIntWidget
* @short_description: Widget containing a label and a widget with an
* integer "value" property.
*
* This widget is a subclass of #GimpLabeled.
**/
enum
{
VALUE_CHANGED,
LAST_SIGNAL
};
enum
{
PROP_0,
PROP_VALUE,
PROP_WIDGET,
};
typedef struct _GimpLabelIntWidgetPrivate
{
GimpLabeled parent_instance;
GtkWidget *widget;
gint value;
} GimpLabelIntWidgetPrivate;
static void gimp_label_int_widget_constructed (GObject *object);
static void gimp_label_int_widget_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_label_int_widget_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static GtkWidget * gimp_label_int_widget_populate (GimpLabeled *widget,
gint *x,
gint *y,
gint *width,
gint *height);
G_DEFINE_TYPE_WITH_PRIVATE (GimpLabelIntWidget, gimp_label_int_widget, GIMP_TYPE_LABELED)
#define parent_class gimp_label_int_widget_parent_class
static guint gimp_label_int_widget_signals[LAST_SIGNAL] = { 0 };
static void
gimp_label_int_widget_class_init (GimpLabelIntWidgetClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GimpLabeledClass *labeled_class = GIMP_LABELED_CLASS (klass);
gimp_label_int_widget_signals[VALUE_CHANGED] =
g_signal_new ("value-changed",
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GimpLabelIntWidgetClass, value_changed),
NULL, NULL, NULL,
G_TYPE_NONE, 0);
object_class->constructed = gimp_label_int_widget_constructed;
object_class->set_property = gimp_label_int_widget_set_property;
object_class->get_property = gimp_label_int_widget_get_property;
labeled_class->populate = gimp_label_int_widget_populate;
/**
* GimpLabelIntWidget:value:
*
* The currently set value.
*
* Since: 3.0
**/
g_object_class_install_property (object_class, PROP_VALUE,
g_param_spec_int ("value", NULL,
"Current value",
G_MININT, G_MAXINT, 0,
GIMP_PARAM_READWRITE));
/**
* GimpLabelIntWidget:widget:
*
* The widget holding an integer value.
*
* Since: 3.0
**/
g_object_class_install_property (object_class, PROP_WIDGET,
g_param_spec_object ("widget", NULL,
"Integer widget",
GTK_TYPE_WIDGET,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
}
static void
gimp_label_int_widget_init (GimpLabelIntWidget *widget)
{
}
static void
gimp_label_int_widget_constructed (GObject *object)
{
GimpLabelIntWidget *widget = GIMP_LABEL_INT_WIDGET (object);
GimpLabelIntWidgetPrivate *priv = gimp_label_int_widget_get_instance_private (widget);
G_OBJECT_CLASS (parent_class)->constructed (object);
/* This is important to make this object into a property widget. It
* will allow config object to bind the "value" property of this
* widget, and therefore be updated automatically.
*/
g_object_bind_property (G_OBJECT (priv->widget), "value",
object, "value",
G_BINDING_BIDIRECTIONAL |
G_BINDING_SYNC_CREATE);
}
static void
gimp_label_int_widget_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpLabelIntWidget *widget = GIMP_LABEL_INT_WIDGET (object);
GimpLabelIntWidgetPrivate *priv = gimp_label_int_widget_get_instance_private (widget);
switch (property_id)
{
case PROP_VALUE:
priv->value = g_value_get_int (value);
g_signal_emit (object, gimp_label_int_widget_signals[VALUE_CHANGED], 0);
break;
case PROP_WIDGET:
priv->widget = g_value_get_object (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_label_int_widget_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpLabelIntWidget *widget = GIMP_LABEL_INT_WIDGET (object);
GimpLabelIntWidgetPrivate *priv = gimp_label_int_widget_get_instance_private (widget);
switch (property_id)
{
case PROP_VALUE:
g_value_set_int (value, priv->value);
break;
case PROP_WIDGET:
g_value_set_object (value, priv->widget);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static GtkWidget *
gimp_label_int_widget_populate (GimpLabeled *labeled,
gint *x,
gint *y,
gint *width,
gint *height)
{
GimpLabelIntWidget *widget = GIMP_LABEL_INT_WIDGET (labeled);
GimpLabelIntWidgetPrivate *priv = gimp_label_int_widget_get_instance_private (widget);
gtk_grid_attach (GTK_GRID (widget), priv->widget, 1, 0, 1, 1);
gtk_widget_show (priv->widget);
return priv->widget;
}
/* Public Functions */
/**
* gimp_label_int_widget_new:
* @text: The text for the #GtkLabel.
* @widget: (transfer full): The #GtkWidget to use.
*
* Creates a new #GimpLabelIntWidget whose "value" property is bound to
* that of @widget (which must therefore have such an integer property).
*
* Returns: (transfer full): The new #GimpLabelIntWidget widget.
**/
GtkWidget *
gimp_label_int_widget_new (const gchar *text,
GtkWidget *widget)
{
GtkWidget *int_widget;
GParamSpec *pspec;
g_return_val_if_fail ((pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (widget),
"value")) &&
G_PARAM_SPEC_TYPE (pspec) == G_TYPE_PARAM_INT,
NULL);
int_widget = g_object_new (GIMP_TYPE_LABEL_INT_WIDGET,
"label", text,
"widget", widget,
NULL);
return int_widget;
}