gimpenumcombobox.c 5.95 KB
Newer Older
1 2
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
3
 *
4
 * gimpenumcombobox.c
Sven Neumann's avatar
Sven Neumann committed
5
 * Copyright (C) 2004  Sven Neumann <sven@gimp.org>
6
 *
7
 * This library is free software: you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 3 of the License, or (at your option) any later version.
11
 *
12
 * This library is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with this library.  If not, see
19
 * <https://www.gnu.org/licenses/>.
20 21 22 23 24 25
 */

#include "config.h"

#include <gtk/gtk.h>

26
#include "gimpwidgetstypes.h"
27 28 29 30

#include "gimpenumcombobox.h"
#include "gimpenumstore.h"

31
#include "libgimp/libgimp-intl.h"
32 33


34 35 36 37 38 39 40 41 42
/**
 * SECTION: gimpenumcombobox
 * @title: GimpEnumComboBox
 * @short_description: A #GimpIntComboBox subclass for selecting an enum value.
 *
 * A #GtkComboBox subclass for selecting an enum value.
 **/


43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
enum
{
  PROP_0,
  PROP_MODEL
};


static void  gimp_enum_combo_box_set_property (GObject      *object,
                                               guint         prop_id,
                                               const GValue *value,
                                               GParamSpec   *pspec);
static void  gimp_enum_combo_box_get_property (GObject      *object,
                                               guint         prop_id,
                                               GValue       *value,
                                               GParamSpec   *pspec);


60
G_DEFINE_TYPE (GimpEnumComboBox, gimp_enum_combo_box,
61
               GIMP_TYPE_INT_COMBO_BOX)
62 63 64

#define parent_class gimp_enum_combo_box_parent_class

65

66 67 68 69 70 71 72 73 74 75 76
static void
gimp_enum_combo_box_class_init (GimpEnumComboBoxClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->set_property = gimp_enum_combo_box_set_property;
  object_class->get_property = gimp_enum_combo_box_get_property;

  /*  override the "model" property of GtkComboBox  */
  g_object_class_install_property (object_class,
                                   PROP_MODEL,
77 78 79
                                   g_param_spec_object ("model",
                                                        "Model",
                                                        "The enum store used by this combo box",
80
                                                        GIMP_TYPE_ENUM_STORE,
81
                                                        GIMP_PARAM_READWRITE));
82 83
}

84 85 86 87 88
static void
gimp_enum_combo_box_init (GimpEnumComboBox *combo_box)
{
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
static void
gimp_enum_combo_box_set_property (GObject      *object,
                                  guint         prop_id,
                                  const GValue *value,
                                  GParamSpec   *pspec)
{
  GtkComboBox *combo_box = GTK_COMBO_BOX (object);

  switch (prop_id)
    {
    case PROP_MODEL:
      gtk_combo_box_set_model (combo_box, g_value_get_object (value));
      break;

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

static void
gimp_enum_combo_box_get_property (GObject    *object,
                                  guint       prop_id,
                                  GValue     *value,
                                  GParamSpec *pspec)
{
  GtkComboBox *combo_box = GTK_COMBO_BOX (object);

  switch (prop_id)
    {
    case PROP_MODEL:
      g_value_set_object (value, gtk_combo_box_get_model (combo_box));
      break;

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


130 131 132 133
/**
 * gimp_enum_combo_box_new:
 * @enum_type: the #GType of an enum.
 *
134 135
 * Creates a #GtkComboBox readily filled with all enum values from a
 * given @enum_type. The enum needs to be registered to the type
136 137 138
 * system. It should also have %GimpEnumDesc descriptions registered
 * that contain translatable value names. This is the case for the
 * enums used in the GIMP PDB functions.
139 140 141 142
 *
 * This is just a convenience function. If you need more control over
 * the enum values that appear in the combo_box, you can create your
 * own #GimpEnumStore and use gimp_enum_combo_box_new_with_model().
143 144
 *
 * Return value: a new #GimpEnumComboBox.
145
 *
146
 * Since: 2.4
147 148 149 150 151 152 153 154 155 156 157 158
 **/
GtkWidget *
gimp_enum_combo_box_new (GType enum_type)
{
  GtkListStore *store;
  GtkWidget    *combo_box;

  g_return_val_if_fail (G_TYPE_IS_ENUM (enum_type), NULL);

  store = gimp_enum_store_new (enum_type);

  combo_box = g_object_new (GIMP_TYPE_ENUM_COMBO_BOX,
159
                            "model", store,
160 161
                            NULL);

162
  g_object_unref (store);
163 164 165 166

  return combo_box;
}

167 168 169 170 171 172 173 174
/**
 * gimp_enum_combo_box_new_with_model
 * @enum_store: a #GimpEnumStore to use as the model
 *
 * Creates a #GtkComboBox for the given @enum_store.
 *
 * Return value: a new #GimpEnumComboBox.
 *
175
 * Since: 2.4
176 177 178 179 180 181 182 183 184 185 186
 **/
GtkWidget *
gimp_enum_combo_box_new_with_model (GimpEnumStore *enum_store)
{
  g_return_val_if_fail (GIMP_IS_ENUM_STORE (enum_store), NULL);

  return g_object_new (GIMP_TYPE_ENUM_COMBO_BOX,
                       "model", enum_store,
                       NULL);
}

187 188 189 190 191 192 193 194 195
/**
 * gimp_enum_combo_box_set_icon_prefix:
 * @combo_box:   a #GimpEnumComboBox
 * @icon_prefix: a prefix to create icon names from enum values
 *
 * Attempts to create icons for all items in the @combo_box. See
 * gimp_enum_store_set_icon_prefix() to find out what to use as
 * @icon_prefix.
 *
196
 * Since: 2.10
197 198 199 200
 **/
void
gimp_enum_combo_box_set_icon_prefix (GimpEnumComboBox *combo_box,
                                     const gchar      *icon_prefix)
201 202 203 204 205 206 207
{
  GtkTreeModel *model;

  g_return_if_fail (GIMP_IS_ENUM_COMBO_BOX (combo_box));

  model = gtk_combo_box_get_model (GTK_COMBO_BOX (combo_box));

208
  gimp_enum_store_set_icon_prefix (GIMP_ENUM_STORE (model), icon_prefix);
209
}