PIKApp/libpikawidgets/pikaintradioframe.c

/* LIBPIKA - The PIKA Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * pikaintradioframe.c
 * Copyright (C) 2022 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
 * 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
 * <https://www.gnu.org/licenses/>.
 */

#include "config.h"

#include <libintl.h>

#include <gtk/gtk.h>

#include "libpikabase/pikabase.h"

#include "pikawidgetstypes.h"

#include "pikaintradioframe.h"
#include "pikaintstore.h"


/**
 * SECTION: pikaintradioframe
 * @title: PikaIntRadioFrame
 * @short_description: A widget providing radio buttons for integer
 *                     values (e.g. enums).
 *
 * A widget providing a frame with title, containing grouped radio
 * buttons, each associated with an integer value and random user data.
 **/


enum
{
  PROP_0,
  PROP_VALUE,
  PROP_STORE,
};


typedef struct _PikaIntRadioFramePrivate PikaIntRadioFramePrivate;

struct _PikaIntRadioFramePrivate
{
  gchar                            *label;
  PikaIntStore                     *store;
  GSList                           *group;
  gint                              value;

  GtkWidget                        *box;

  PikaIntRadioFrameSensitivityFunc  sensitivity_func;
  gpointer                          sensitivity_data;
  GDestroyNotify                    sensitivity_destroy;
};

#define GET_PRIVATE(obj) ((PikaIntRadioFramePrivate *) pika_int_radio_frame_get_instance_private ((PikaIntRadioFrame *) obj))


static void  pika_int_radio_frame_constructed        (GObject           *object);
static void  pika_int_radio_frame_finalize           (GObject           *object);
static void  pika_int_radio_frame_set_property       (GObject           *object,
                                                      guint              property_id,
                                                      const GValue      *value,
                                                      GParamSpec        *pspec);
static void  pika_int_radio_frame_get_property       (GObject           *object,
                                                      guint              property_id,
                                                      GValue            *value,
                                                      GParamSpec        *pspec);

static gboolean pika_int_radio_frame_draw            (GtkWidget         *widget,
                                                      cairo_t           *cr,
                                                      gpointer           user_data);

static void  pika_int_radio_frame_fill               (PikaIntRadioFrame *frame);
static void  pika_int_radio_frame_set_store          (PikaIntRadioFrame *frame,
                                                      PikaIntStore      *store);
static void  pika_int_radio_frame_update_sensitivity (PikaIntRadioFrame *frame);

static void  pika_int_radio_frame_button_toggled     (GtkToggleButton   *button,
                                                     PikaIntRadioFrame *frame);


G_DEFINE_TYPE_WITH_PRIVATE (PikaIntRadioFrame, pika_int_radio_frame,
                            PIKA_TYPE_FRAME)

#define parent_class pika_int_radio_frame_parent_class


static void
pika_int_radio_frame_class_init (PikaIntRadioFrameClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->constructed  = pika_int_radio_frame_constructed;
  object_class->finalize     = pika_int_radio_frame_finalize;
  object_class->set_property = pika_int_radio_frame_set_property;
  object_class->get_property = pika_int_radio_frame_get_property;

  /**
   * PikaIntRadioFrame:value:
   *
   * The active value
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class, PROP_VALUE,
                                   g_param_spec_int ("value",
                                                     "Value",
                                                     "Value of active item",
                                                     G_MININT, G_MAXINT, 0,
                                                     PIKA_PARAM_READWRITE |
                                                     G_PARAM_EXPLICIT_NOTIFY));

  /**
   * PikaIntRadioFrame:store:
   *
   * The %PikaIntStore from which the radio frame takes the values shown
   * in the list.
   *
   * Since: 3.0
   */
  g_object_class_install_property (object_class,
                                   PROP_STORE,
                                   g_param_spec_object ("store",
                                                        "PikaRadioFrame int store",
                                                        "The int store for the radio frame",
                                                        PIKA_TYPE_INT_STORE,
                                                        PIKA_PARAM_READWRITE |
                                                        G_PARAM_EXPLICIT_NOTIFY));
}

static void
pika_int_radio_frame_init (PikaIntRadioFrame *radio_frame)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (radio_frame);

  priv->box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 2);
  gtk_container_add (GTK_CONTAINER (radio_frame), priv->box);
  gtk_widget_show (GTK_WIDGET (priv->box));
}

static void
pika_int_radio_frame_constructed (GObject *object)
{
  G_OBJECT_CLASS (parent_class)->constructed (object);

  g_signal_connect (object, "draw",
                    G_CALLBACK (pika_int_radio_frame_draw),
                    NULL);
}

static void
pika_int_radio_frame_finalize (GObject *object)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (object);

  g_clear_pointer (&priv->label, g_free);
  g_clear_object (&priv->store);
  g_clear_pointer (&priv->group, g_slist_free);

  if (priv->sensitivity_destroy)
    {
      GDestroyNotify d = priv->sensitivity_destroy;

      priv->sensitivity_destroy = NULL;
      d (priv->sensitivity_data);
    }

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

static void
pika_int_radio_frame_set_property (GObject      *object,
                                   guint         property_id,
                                   const GValue *value,
                                   GParamSpec   *pspec)
{
  switch (property_id)
    {
    case PROP_VALUE:
      pika_int_radio_frame_set_active (PIKA_INT_RADIO_FRAME (object),
                                       g_value_get_int (value));
      break;
    case PROP_STORE:
      pika_int_radio_frame_set_store (PIKA_INT_RADIO_FRAME (object),
                                      g_value_get_object (value));
      break;


    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
pika_int_radio_frame_get_property (GObject    *object,
                                   guint       property_id,
                                   GValue     *value,
                                   GParamSpec *pspec)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (object);

  switch (property_id)
    {
    case PROP_VALUE:
      g_value_set_int (value, priv->value);
    break;
      case PROP_STORE:
        g_value_set_object (value, priv->store);
        break;


    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

/* Public functions */

/**
 * pika_int_radio_frame_new_from_store:
 * @title: the frame label.
 * @store: the %PikaIntStore to generate radio buttons from.
 *
 * Creates a %PikaIntRadioFrame containing radio buttons for each item
 * in the @store. The created widget takes ownership of @store.
 *
 * If you need to construct an empty #PikaIntRadioFrame, it's best to use
 * g_object_new (PIKA_TYPE_INT_RADIO_FRAME, NULL).
 *
 * Returns: a new #PikaIntRadioFrame.
 *
 * Since: 3.0
 **/
GtkWidget *
pika_int_radio_frame_new_from_store (const gchar  *title,
                                     PikaIntStore *store)
{
  GtkWidget *radio_frame;

  radio_frame = g_object_new (PIKA_TYPE_INT_RADIO_FRAME,
                              "label", title,
                              "store", store,
                              NULL);

  return radio_frame;
}

/**
 * pika_int_radio_frame_new: (skip)
 * @first_label: the label of the first item
 * @first_value: the value of the first item
 * @...: a %NULL terminated list of more label, value pairs
 *
 * Creates a GtkComboBox that has integer values associated with each
 * item. The items to fill the combo box with are specified as a %NULL
 * terminated list of label/value pairs.
 *
 * If you need to construct an empty #PikaIntRadioFrame, it's best to use
 * g_object_new (PIKA_TYPE_INT_RADIO_FRAME, NULL).
 *
 * Returns: a new #PikaIntRadioFrame.
 *
 * Since: 3.0
 **/
GtkWidget *
pika_int_radio_frame_new (const gchar *first_label,
                          gint         first_value,
                          ...)
{
  GtkWidget *radio_frame;
  va_list    args;

  va_start (args, first_value);

  radio_frame = pika_int_radio_frame_new_valist (first_label, first_value, args);

  va_end (args);

  return radio_frame;
}

/**
 * pika_int_radio_frame_new_valist: (skip)
 * @first_label: the label of the first item
 * @first_value: the value of the first item
 * @values: a va_list with more values
 *
 * A variant of pika_int_radio_frame_new() that takes a va_list of
 * label/value pairs.
 *
 * Returns: a new #PikaIntRadioFrame.
 *
 * Since: 3.0
 **/
GtkWidget *
pika_int_radio_frame_new_valist (const gchar *first_label,
                                 gint         first_value,
                                 va_list      values)
{
  GtkWidget    *radio_frame;
  GtkListStore *store;

  store = pika_int_store_new_valist (first_label, first_value, values);

  radio_frame = g_object_new (PIKA_TYPE_INT_RADIO_FRAME,
                              "store", store,
                              NULL);

  return radio_frame;
}

/**
 * pika_int_radio_frame_new_array: (rename-to pika_int_radio_frame_new)
 * @labels: (array zero-terminated=1): a %NULL-terminated array of labels.
 *
 * A variant of pika_int_radio_frame_new() that takes an array of labels.
 * The array indices are used as values.
 *
 * Returns: a new #PikaIntRadioFrame.
 *
 * Since: 3.0
 **/
GtkWidget *
pika_int_radio_frame_new_array (const gchar *labels[])
{
  GtkWidget                *frame;
  PikaIntRadioFramePrivate *priv;
  GtkListStore             *store;
  gint                      i;

  g_return_val_if_fail (labels != NULL, NULL);

  frame = g_object_new (PIKA_TYPE_INT_RADIO_FRAME, NULL);
  priv  = GET_PRIVATE (frame);
  store = GTK_LIST_STORE (priv->store);

  for (i = 0; labels[i] != NULL; i++)
    {
      GtkTreeIter  iter;

      if (labels[i])
        {
          gtk_list_store_append (store, &iter);
          gtk_list_store_set (store, &iter,
                              PIKA_INT_STORE_VALUE, i,
                              PIKA_INT_STORE_LABEL, labels[i],
                              -1);
        }
    }

  return frame;
}

/**
 * pika_int_radio_frame_prepend: (skip)
 * @radio_frame: a #PikaIntRadioFrame
 * @...:       pairs of column number and value, terminated with -1
 *
 * This function provides a convenient way to prepend items to a
 * #PikaIntRadioFrame. It prepends a row to the @radio_frame's list store
 * and calls gtk_list_store_set() for you.
 *
 * The column number must be taken from the enum #PikaIntStoreColumns.
 *
 * Since: 3.0
 **/
void
pika_int_radio_frame_prepend (PikaIntRadioFrame *radio_frame,
                            ...)
{
  GtkListStore             *store;
  PikaIntRadioFramePrivate *priv;
  GtkTreeIter               iter;
  va_list                   args;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (radio_frame));

  priv  = GET_PRIVATE (radio_frame);
  store = GTK_LIST_STORE (priv->store);

  va_start (args, radio_frame);

  gtk_list_store_prepend (store, &iter);
  gtk_list_store_set_valist (store, &iter, args);

  va_end (args);
}

/**
 * pika_int_radio_frame_append: (skip)
 * @radio_frame: a #PikaIntRadioFrame
 * @...:         pairs of column number and value, terminated with -1
 *
 * This function provides a convenient way to append items to a
 * #PikaIntRadioFrame. It appends a row to the @radio_frame's list store
 * and calls gtk_list_store_set() for you.
 *
 * The column number must be taken from the enum #PikaIntStoreColumns.
 *
 * Since: 3.0
 **/
void
pika_int_radio_frame_append (PikaIntRadioFrame *radio_frame,
                             ...)
{
  GtkListStore             *store;
  PikaIntRadioFramePrivate *priv;
  GtkTreeIter               iter;
  va_list                   args;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (radio_frame));

  priv  = GET_PRIVATE (radio_frame);
  store = GTK_LIST_STORE (priv->store);

  va_start (args, radio_frame);

  gtk_list_store_append (store, &iter);
  gtk_list_store_set_valist (store, &iter, args);

  va_end (args);
}

/**
 * pika_int_radio_frame_set_active:
 * @radio_frame: a #PikaIntRadioFrame
 * @value:       an integer value
 *
 * Looks up the item that belongs to the given @value and makes it the
 * selected item in the @radio_frame.
 *
 * Returns: %TRUE on success (value changed or not) or %FALSE if there
 *          was no item for this value.
 *
 * Since: 3.0
 **/
gboolean
pika_int_radio_frame_set_active (PikaIntRadioFrame *frame,
                                 gint               value)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (frame);
  GtkWidget                *button;
  GSList                   *iter = priv->group;

  g_return_val_if_fail (PIKA_IS_INT_RADIO_FRAME (frame), FALSE);

  for (; iter; iter = g_slist_next (iter))
    {
      button = GTK_WIDGET (iter->data);

      if (g_object_get_data (G_OBJECT (button), "pika-radio-frame-value") ==
          GINT_TO_POINTER (value))
        {
          if (! gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)))
            gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), TRUE);

          return TRUE;
        }
    }

  return FALSE;
}

/**
 * pika_int_radio_frame_get_active:
 * @radio_frame: a #PikaIntRadioFrame
 *
 * Returns: the value of the active item.
 *
 * Since:3.0
 **/
gint
pika_int_radio_frame_get_active (PikaIntRadioFrame *frame)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (frame);

  g_return_val_if_fail (PIKA_IS_INT_RADIO_FRAME (frame), FALSE);

  return priv->value;
}

/**
 * pika_int_radio_frame_set_active_by_user_data:
 * @radio_frame: a #PikaIntRadioFrame
 * @user_data: an integer value
 *
 * Looks up the item that has the given @user_data and makes it the
 * selected item in the @radio_frame.
 *
 * Returns: %TRUE on success or %FALSE if there was no item for
 *          this user-data.
 *
 * Since: 3.0
 **/
gboolean
pika_int_radio_frame_set_active_by_user_data (PikaIntRadioFrame *radio_frame,
                                              gpointer           user_data)
{
  PikaIntRadioFramePrivate *priv;
  GtkTreeIter               iter;

  g_return_val_if_fail (PIKA_IS_INT_RADIO_FRAME (radio_frame), FALSE);

  priv = GET_PRIVATE (radio_frame);

  if (pika_int_store_lookup_by_user_data (GTK_TREE_MODEL (priv->store), user_data, &iter))
    {
      gint value;

      gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &iter,
                          PIKA_INT_STORE_VALUE, &value,
                          -1);
      pika_int_radio_frame_set_active (radio_frame, value);

      return TRUE;
    }

  return FALSE;
}

/**
 * pika_int_radio_frame_get_active_user_data:
 * @radio_frame: a #PikaIntRadioFrame
 * @user_data: (out) (transfer none): return location for the gpointer value
 *
 * Retrieves the user-data of the selected (active) item in the @radio_frame.
 *
 * Returns: %TRUE if @user_data has been set or %FALSE if no item was
 *               active.
 *
 * Since: 3.0
 **/
gboolean
pika_int_radio_frame_get_active_user_data (PikaIntRadioFrame *radio_frame,
                                           gpointer          *user_data)
{
  PikaIntRadioFramePrivate *priv;
  GtkTreeIter               iter;

  g_return_val_if_fail (PIKA_IS_INT_RADIO_FRAME (radio_frame), FALSE);
  g_return_val_if_fail (user_data != NULL, FALSE);

  priv = GET_PRIVATE (radio_frame);

  if (pika_int_store_lookup_by_value (GTK_TREE_MODEL (priv->store), priv->value, &iter))
    {
      gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &iter,
                          PIKA_INT_STORE_USER_DATA,      user_data,
                          -1);
      return TRUE;
    }

  return FALSE;
}

/**
 * pika_int_radio_frame_set_sensitivity:
 * @radio_frame: a #PikaIntRadioFrame
 * @func: a function that returns a boolean value, or %NULL to unset
 * @data: data to pass to @func
 * @destroy: destroy notification for @data
 *
 * Sets a function that is used to decide about the sensitivity of radio
 * buttons in the @radio_frame. Use this if you want to set certain
 * radio buttons insensitive.
 *
 * Calling gtk_widget_queue_draw() on the @radio_frame will cause the
 * sensitivity to be updated.
 *
 * Since: 3.0
 **/
void
pika_int_radio_frame_set_sensitivity (PikaIntRadioFrame      *radio_frame,
                                      PikaIntRadioFrameSensitivityFunc  func,
                                      gpointer                data,
                                      GDestroyNotify          destroy)
{
  PikaIntRadioFramePrivate *priv;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (radio_frame));

  priv = GET_PRIVATE (radio_frame);

  if (priv->sensitivity_destroy)
    {
      GDestroyNotify destroy = priv->sensitivity_destroy;

      priv->sensitivity_destroy = NULL;
      destroy (priv->sensitivity_data);
    }

  priv->sensitivity_func    = func;
  priv->sensitivity_data    = data;
  priv->sensitivity_destroy = destroy;
}


/* Private functions */

static gboolean
pika_int_radio_frame_draw (GtkWidget *widget,
                           cairo_t   *cr,
                           gpointer   user_data)
{
  pika_int_radio_frame_update_sensitivity (PIKA_INT_RADIO_FRAME (widget));

  return FALSE;
}

static void
pika_int_radio_frame_fill (PikaIntRadioFrame *frame)
{
  PikaIntRadioFramePrivate *priv;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (frame));

  priv = GET_PRIVATE (frame);

  g_clear_pointer (&priv->group, g_slist_free);
  gtk_container_foreach (GTK_CONTAINER (priv->box),
                         (GtkCallback) gtk_widget_destroy, NULL);

  if (priv->store)
    {
      GtkTreeModel *model;
      GSList       *group = NULL;
      GtkTreeIter   iter;
      gboolean      iter_valid;

      model = GTK_TREE_MODEL (priv->store);

      for (iter_valid = gtk_tree_model_get_iter_first (model, &iter);
           iter_valid;
           iter_valid = gtk_tree_model_iter_next (model, &iter))
        {
          GtkWidget *button;
          gchar     *label;
          gint       value;

          gtk_tree_model_get (model, &iter,
                              PIKA_INT_STORE_LABEL, &label,
                              PIKA_INT_STORE_VALUE, &value,
                              -1);

          button = gtk_radio_button_new_with_mnemonic (group, label);
          gtk_box_pack_start (GTK_BOX (priv->box), button, FALSE, FALSE, 0);
          gtk_widget_show (button);

          g_free (label);

          group = gtk_radio_button_get_group (GTK_RADIO_BUTTON (button));

          g_object_set_data (G_OBJECT (button), "pika-radio-frame-value",
                             GINT_TO_POINTER (value));

          g_signal_connect (button, "toggled",
                            G_CALLBACK (pika_int_radio_frame_button_toggled),
                            frame);
        }
      priv->group = g_slist_copy (group);

      pika_int_radio_frame_set_active (frame, priv->value);
    }
}

static void
pika_int_radio_frame_set_store (PikaIntRadioFrame *frame,
                                PikaIntStore      *store)
{
  PikaIntRadioFramePrivate *priv;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (frame));
  g_return_if_fail (PIKA_IS_INT_STORE (store));

  priv = GET_PRIVATE (frame);

  if (priv->store == store)
    return;

  if (priv->store)
    {
      g_signal_handlers_disconnect_by_func (priv->store,
                                            (GCallback) pika_int_radio_frame_fill,
                                            NULL);
      g_object_unref (priv->store);
    }

  priv->store = g_object_ref (store);

  if (priv->store)
    {
      g_signal_connect_object (priv->store, "row-changed",
                               (GCallback) pika_int_radio_frame_fill,
                               frame, G_CONNECT_SWAPPED);
      g_signal_connect_object (priv->store, "row-deleted",
                               (GCallback) pika_int_radio_frame_fill,
                               frame, G_CONNECT_SWAPPED);
      g_signal_connect_object (priv->store, "row-inserted",
                               (GCallback) pika_int_radio_frame_fill,
                               frame, G_CONNECT_SWAPPED);
      g_signal_connect_object (priv->store, "rows-reordered",
                               (GCallback) pika_int_radio_frame_fill,
                               frame, G_CONNECT_SWAPPED);
    }

  pika_int_radio_frame_fill (frame);

  g_object_notify (G_OBJECT (frame), "store");
}

static void
pika_int_radio_frame_update_sensitivity (PikaIntRadioFrame *frame)
{
  PikaIntRadioFramePrivate *priv = GET_PRIVATE (frame);
  GSList                   *iter = priv->group;

  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (frame));

  if (! priv->sensitivity_func)
    return;

  for (; iter; iter = g_slist_next (iter))
    {
      GtkWidget   *button = GTK_WIDGET (iter->data);
      GtkTreeIter  tree_iter;
      gint         value;

      value = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (button), "pika-radio-frame-value"));

      gtk_widget_set_sensitive (button, TRUE);
      if (pika_int_store_lookup_by_value (GTK_TREE_MODEL (priv->store), value, &tree_iter))
        {
          gpointer user_data;
          gint     new_value = value;

          gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &tree_iter,
                              PIKA_INT_STORE_USER_DATA,     &user_data,
                              -1);
          if (! priv->sensitivity_func (value, user_data, &new_value,
                                        priv->sensitivity_data))
            {
              if (new_value != value)
                pika_int_radio_frame_set_active (frame, new_value);

              gtk_widget_set_sensitive (button, FALSE);
            }
        }
    }
}

static void
pika_int_radio_frame_button_toggled (GtkToggleButton   *button,
                                     PikaIntRadioFrame *frame)
{
  g_return_if_fail (PIKA_IS_INT_RADIO_FRAME (frame));
  g_return_if_fail (GTK_IS_RADIO_BUTTON (button));

  if (gtk_toggle_button_get_active (button))
    {
      PikaIntRadioFramePrivate *priv = GET_PRIVATE (frame);
      gint                      value;

      value = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (button), "pika-radio-frame-value"));

      if (priv->value != value)
        {
          priv->value = value;
          g_object_notify (G_OBJECT (frame), "value");
        }
    }
}