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

26 27 28 29
#if !defined (__GIMP_WIDGETS_H_INSIDE__) && !defined (GIMP_WIDGETS_COMPILATION)
#error "Only <libgimpwidgets/gimpwidgets.h> can be included directly."
#endif

30 31 32 33 34 35 36 37
#ifndef __GIMP_COLOR_SELECTOR_H__
#define __GIMP_COLOR_SELECTOR_H__

G_BEGIN_DECLS

/* For information look at the html documentation */


38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * GIMP_COLOR_SELECTOR_SIZE:
 *
 * The suggested size for a color area in a #GimpColorSelector
 * implementation.
 **/
#define GIMP_COLOR_SELECTOR_SIZE     150

/**
 * GIMP_COLOR_SELECTOR_BAR_SIZE:
 *
 * The suggested width for a color bar in a #GimpColorSelector
 * implementation.
 **/
#define GIMP_COLOR_SELECTOR_BAR_SIZE 15
53 54 55 56 57 58 59 60 61 62 63 64 65 66


#define GIMP_TYPE_COLOR_SELECTOR            (gimp_color_selector_get_type ())
#define GIMP_COLOR_SELECTOR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_COLOR_SELECTOR, GimpColorSelector))
#define GIMP_COLOR_SELECTOR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_COLOR_SELECTOR, GimpColorSelectorClass))
#define GIMP_IS_COLOR_SELECTOR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_COLOR_SELECTOR))
#define GIMP_IS_COLOR_SELECTOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_COLOR_SELECTOR))
#define GIMP_COLOR_SELECTOR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_COLOR_SELECTOR, GimpColorSelectorClass))


typedef struct _GimpColorSelectorClass GimpColorSelectorClass;

struct _GimpColorSelector
{
67
  GtkBox                    parent_instance;
68

69 70
  gboolean                  toggles_visible;
  gboolean                  toggles_sensitive;
71 72 73 74 75
  gboolean                  show_alpha;

  GimpRGB                   rgb;
  GimpHSV                   hsv;

76
  GimpColorSelectorModel    model;
77
  GimpColorSelectorChannel  channel;
78 79 80 81
};

struct _GimpColorSelectorClass
{
82
  GtkBoxClass  parent_class;
83

84 85
  const gchar *name;
  const gchar *help_id;
86 87 88
#ifdef GIMP_DISABLE_DEPRECATED
  gpointer     deprecated_stock_id;
#else
89
  const gchar *stock_id;
90
#endif
91 92

  /*  virtual functions  */
93 94 95 96 97 98 99 100 101 102 103
  void (* set_toggles_visible)   (GimpColorSelector        *selector,
                                  gboolean                  visible);
  void (* set_toggles_sensitive) (GimpColorSelector        *selector,
                                  gboolean                  sensitive);
  void (* set_show_alpha)        (GimpColorSelector        *selector,
                                  gboolean                  show_alpha);
  void (* set_color)             (GimpColorSelector        *selector,
                                  const GimpRGB            *rgb,
                                  const GimpHSV            *hsv);
  void (* set_channel)           (GimpColorSelector        *selector,
                                  GimpColorSelectorChannel  channel);
104 105

  /*  signals  */
106 107 108 109 110
  void (* color_changed)         (GimpColorSelector        *selector,
                                  const GimpRGB            *rgb,
                                  const GimpHSV            *hsv);
  void (* channel_changed)       (GimpColorSelector        *selector,
                                  GimpColorSelectorChannel  channel);
111

112 113 114 115
  /*  another virtual function  */
  void (* set_config)            (GimpColorSelector        *selector,
                                  GimpColorConfig          *config);

116 117 118
  /*  icon name  */
  const gchar *icon_name;

119 120 121 122 123 124 125
  /*  another virtual function  */
  void (* set_model)             (GimpColorSelector        *selector,
                                  GimpColorSelectorModel    model);

  /*  another signal  */
  void (* model_changed)         (GimpColorSelector        *selector,
                                  GimpColorSelectorModel    model);
126 127 128
};


129 130 131 132 133 134
GType       gimp_color_selector_get_type         (void) G_GNUC_CONST;
GtkWidget * gimp_color_selector_new              (GType              selector_type,
                                                  const GimpRGB     *rgb,
                                                  const GimpHSV     *hsv,
                                                  GimpColorSelectorChannel  channel);

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
void     gimp_color_selector_set_toggles_visible   (GimpColorSelector *selector,
                                                    gboolean           visible);
gboolean gimp_color_selector_get_toggles_visible   (GimpColorSelector *selector);

void     gimp_color_selector_set_toggles_sensitive (GimpColorSelector *selector,
                                                    gboolean           sensitive);
gboolean gimp_color_selector_get_toggles_sensitive (GimpColorSelector *selector);

void     gimp_color_selector_set_show_alpha        (GimpColorSelector *selector,
                                                    gboolean           show_alpha);
gboolean gimp_color_selector_get_show_alpha        (GimpColorSelector *selector);

void     gimp_color_selector_set_color             (GimpColorSelector *selector,
                                                    const GimpRGB     *rgb,
                                                    const GimpHSV     *hsv);
void     gimp_color_selector_get_color             (GimpColorSelector *selector,
                                                    GimpRGB           *rgb,
                                                    GimpHSV           *hsv);

void     gimp_color_selector_set_channel           (GimpColorSelector *selector,
                                                    GimpColorSelectorChannel  channel);
GimpColorSelectorChannel
         gimp_color_selector_get_channel           (GimpColorSelector *selector);
158 159 160 161
void     gimp_color_selector_set_model             (GimpColorSelector *selector,
                                                    GimpColorSelectorModel  model);
GimpColorSelectorModel
         gimp_color_selector_get_model             (GimpColorSelector *selector);
162 163 164 165 166 167

void     gimp_color_selector_color_changed         (GimpColorSelector *selector);
void     gimp_color_selector_channel_changed       (GimpColorSelector *selector);

void     gimp_color_selector_set_config            (GimpColorSelector *selector,
                                                    GimpColorConfig   *config);
168

169 170 171 172

G_END_DECLS

#endif /* __GIMP_COLOR_SELECTOR_H__ */