summaryrefslogtreecommitdiffstats
path: root/libgimpwidgets/gimpcolorselector.h
blob: d6c666093fee27fa1dbb34647986aa90df0f59c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/* LIBGIMP - The GIMP Library
 * 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>
 *
 * 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/>.
 */

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

#ifndef __GIMP_COLOR_SELECTOR_H__
#define __GIMP_COLOR_SELECTOR_H__

G_BEGIN_DECLS

/* For information look at the html documentation */


/**
 * 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


#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
{
  GtkBox                    parent_instance;

  gboolean                  toggles_visible;
  gboolean                  toggles_sensitive;
  gboolean                  show_alpha;

  GimpRGB                   rgb;
  GimpHSV                   hsv;

  GimpColorSelectorChannel  channel;
};

struct _GimpColorSelectorClass
{
  GtkBoxClass  parent_class;

  const gchar *name;
  const gchar *help_id;
#ifdef GIMP_DISABLE_DEPRECATED
  gpointer     deprecated_stock_id;
#else
  const gchar *stock_id;
#endif

  /*  virtual functions  */
  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);

  /*  signals  */
  void (* color_changed)         (GimpColorSelector        *selector,
                                  const GimpRGB            *rgb,
                                  const GimpHSV            *hsv);
  void (* channel_changed)       (GimpColorSelector        *selector,
                                  GimpColorSelectorChannel  channel);

  /*  another virtual function  */
  void (* set_config)            (GimpColorSelector        *selector,
                                  GimpColorConfig          *config);

  /*  icon name  */
  const gchar *icon_name;

  /*  another virtual function  */
  void (* set_model_visible)     (GimpColorSelector        *selector,
                                  GimpColorSelectorModel    model,
                                  gboolean                  visible);

  /*  another signal  */
  void (* model_visible_changed) (GimpColorSelector        *selector,
                                  GimpColorSelectorModel    model,
                                  gboolean                  visible);
};


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);

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);

void     gimp_color_selector_set_model_visible     (GimpColorSelector *selector,
                                                    GimpColorSelectorModel model,
                                                    gboolean           visible);
gboolean gimp_color_selector_get_model_visible     (GimpColorSelector *selector,
                                                    GimpColorSelectorModel model);

void     gimp_color_selector_color_changed         (GimpColorSelector *selector);
void     gimp_color_selector_channel_changed       (GimpColorSelector *selector);
void     gimp_color_selector_model_visible_changed (GimpColorSelector *selector,
                                                    GimpColorSelectorModel model);

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


G_END_DECLS

#endif /* __GIMP_COLOR_SELECTOR_H__ */