]> Pileus Git - ~andy/gtk/blob - gtk/gtkcolorsel.h
Add docs
[~andy/gtk] / gtk / gtkcolorsel.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2000 Red Hat, Inc.
3  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 /*
22  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
23  * file for a list of people on the GTK+ Team.  See the ChangeLog
24  * files for a list of changes.  These files are distributed with
25  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26  */
27
28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29 #error "Only <gtk/gtk.h> can be included directly."
30 #endif
31
32 #ifndef __GTK_COLOR_SELECTION_H__
33 #define __GTK_COLOR_SELECTION_H__
34
35 #include <gtk/gtkdialog.h>
36 #include <gtk/gtkbox.h>
37
38 G_BEGIN_DECLS
39
40 #define GTK_TYPE_COLOR_SELECTION                        (gtk_color_selection_get_type ())
41 #define GTK_COLOR_SELECTION(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_COLOR_SELECTION, GtkColorSelection))
42 #define GTK_COLOR_SELECTION_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_COLOR_SELECTION, GtkColorSelectionClass))
43 #define GTK_IS_COLOR_SELECTION(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_COLOR_SELECTION))
44 #define GTK_IS_COLOR_SELECTION_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_COLOR_SELECTION))
45 #define GTK_COLOR_SELECTION_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_COLOR_SELECTION, GtkColorSelectionClass))
46
47
48 typedef struct _GtkColorSelection       GtkColorSelection;
49 typedef struct _GtkColorSelectionPrivate  GtkColorSelectionPrivate;
50 typedef struct _GtkColorSelectionClass  GtkColorSelectionClass;
51
52 typedef void (* GtkColorSelectionChangePaletteFunc) (const GdkColor    *colors,
53                                                      gint               n_colors);
54
55 /**
56  * GtkColorSelectionChangePaletteWithScreenFunc:
57  * @screen:
58  * @colors:
59  * @n_colors:
60  *
61  * Since: 2.2
62  */
63 typedef void (* GtkColorSelectionChangePaletteWithScreenFunc) (GdkScreen         *screen,
64                                                                const GdkColor    *colors,
65                                                                gint               n_colors);
66
67 struct _GtkColorSelection
68 {
69   GtkBox parent_instance;
70
71   /* < private_data > */
72   GtkColorSelectionPrivate *private_data;
73 };
74
75 struct _GtkColorSelectionClass
76 {
77   GtkBoxClass parent_class;
78
79   void (*color_changed) (GtkColorSelection *color_selection);
80
81   /* Padding for future expansion */
82   void (*_gtk_reserved1) (void);
83   void (*_gtk_reserved2) (void);
84   void (*_gtk_reserved3) (void);
85   void (*_gtk_reserved4) (void);
86 };
87
88
89 /* ColorSelection */
90
91 GType      gtk_color_selection_get_type                (void) G_GNUC_CONST;
92 GtkWidget *gtk_color_selection_new                     (void);
93 gboolean   gtk_color_selection_get_has_opacity_control (GtkColorSelection *colorsel);
94 void       gtk_color_selection_set_has_opacity_control (GtkColorSelection *colorsel,
95                                                         gboolean           has_opacity);
96 gboolean   gtk_color_selection_get_has_palette         (GtkColorSelection *colorsel);
97 void       gtk_color_selection_set_has_palette         (GtkColorSelection *colorsel,
98                                                         gboolean           has_palette);
99
100
101 void     gtk_color_selection_set_current_alpha   (GtkColorSelection *colorsel,
102                                                   guint16            alpha);
103 guint16  gtk_color_selection_get_current_alpha   (GtkColorSelection *colorsel);
104 void     gtk_color_selection_set_previous_alpha  (GtkColorSelection *colorsel,
105                                                   guint16            alpha);
106 guint16  gtk_color_selection_get_previous_alpha  (GtkColorSelection *colorsel);
107
108 void     gtk_color_selection_set_current_rgba    (GtkColorSelection *colorsel,
109                                                   const GdkRGBA     *rgba);
110 void     gtk_color_selection_get_current_rgba    (GtkColorSelection *colorsel,
111                                                   GdkRGBA           *rgba);
112 void     gtk_color_selection_set_previous_rgba   (GtkColorSelection *colorsel,
113                                                   const GdkRGBA     *rgba);
114 void     gtk_color_selection_get_previous_rgba   (GtkColorSelection *colorsel,
115                                                   GdkRGBA           *rgba);
116
117 gboolean gtk_color_selection_is_adjusting        (GtkColorSelection *colorsel);
118
119 gboolean gtk_color_selection_palette_from_string (const gchar       *str,
120                                                   GdkColor         **colors,
121                                                   gint              *n_colors);
122 gchar*   gtk_color_selection_palette_to_string   (const GdkColor    *colors,
123                                                   gint               n_colors);
124
125 GtkColorSelectionChangePaletteWithScreenFunc gtk_color_selection_set_change_palette_with_screen_hook (GtkColorSelectionChangePaletteWithScreenFunc func);
126
127 GDK_DEPRECATED_FOR(gtk_color_selection_set_current_rgba)
128 void     gtk_color_selection_set_current_color   (GtkColorSelection *colorsel,
129                                                   const GdkColor    *color);
130 GDK_DEPRECATED_FOR(gtk_color_selection_get_current_rgba)
131 void     gtk_color_selection_get_current_color   (GtkColorSelection *colorsel,
132                                                   GdkColor          *color);
133 GDK_DEPRECATED_FOR(gtk_color_selection_set_previous_rgba)
134 void     gtk_color_selection_set_previous_color  (GtkColorSelection *colorsel,
135                                                   const GdkColor    *color);
136 GDK_DEPRECATED_FOR(gtk_color_selection_get_previous_rgba)
137 void     gtk_color_selection_get_previous_color  (GtkColorSelection *colorsel,
138                                                   GdkColor          *color);
139
140
141 G_END_DECLS
142
143 #endif /* __GTK_COLOR_SELECTION_H__ */