]> Pileus Git - ~andy/gtk/blob - gtk/gtkcolorbutton.h
GtkColorButton: trivial doc and formatting fixes
[~andy/gtk] / gtk / gtkcolorbutton.h
1 /*
2  * GTK - The GIMP Toolkit
3  * Copyright (C) 1998, 1999 Red Hat, Inc.
4  * All rights reserved.
5  *
6  * This Library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public License as
8  * published by the Free Software Foundation; either version 2 of the
9  * License, or (at your option) any later version.
10  *
11  * This Library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
18  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 /* Color picker button for GNOME
23  *
24  * Author: Federico Mena <federico@nuclecu.unam.mx>
25  *
26  * Modified by the GTK+ Team and others 2003.  See the AUTHORS
27  * file for a list of people on the GTK+ Team.  See the ChangeLog
28  * files for a list of changes.  These files are distributed with
29  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30  */
31
32 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 #error "Only <gtk/gtk.h> can be included directly."
34 #endif
35
36 #ifndef __GTK_COLOR_BUTTON_H__
37 #define __GTK_COLOR_BUTTON_H__
38
39
40 #include <gtk/gtkbutton.h>
41
42 G_BEGIN_DECLS
43
44
45 #define GTK_TYPE_COLOR_BUTTON             (gtk_color_button_get_type ())
46 #define GTK_COLOR_BUTTON(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButton))
47 #define GTK_COLOR_BUTTON_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_COLOR_BUTTON, GtkColorButtonClass))
48 #define GTK_IS_COLOR_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_COLOR_BUTTON))
49 #define GTK_IS_COLOR_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_COLOR_BUTTON))
50 #define GTK_COLOR_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButtonClass))
51
52 typedef struct _GtkColorButton          GtkColorButton;
53 typedef struct _GtkColorButtonClass     GtkColorButtonClass;
54 typedef struct _GtkColorButtonPrivate   GtkColorButtonPrivate;
55
56 struct _GtkColorButton {
57   GtkButton button;
58
59   /*< private >*/
60   GtkColorButtonPrivate *priv;
61 };
62
63 struct _GtkColorButtonClass {
64   GtkButtonClass parent_class;
65
66   void (* color_set) (GtkColorButton *cp);
67
68   /* Padding for future expansion */
69   void (*_gtk_reserved1) (void);
70   void (*_gtk_reserved2) (void);
71   void (*_gtk_reserved3) (void);
72   void (*_gtk_reserved4) (void);
73 };
74
75
76 GType      gtk_color_button_get_type       (void) G_GNUC_CONST;
77 GtkWidget *gtk_color_button_new            (void);
78 GtkWidget *gtk_color_button_new_with_color (const GdkColor *color);
79 GtkWidget *gtk_color_button_new_with_rgba  (const GdkRGBA  *rgba);
80 void       gtk_color_button_set_color      (GtkColorButton *color_button,
81                                             const GdkColor *color);
82 void       gtk_color_button_set_alpha      (GtkColorButton *color_button,
83                                             guint16         alpha);
84 void       gtk_color_button_get_color      (GtkColorButton *color_button,
85                                             GdkColor       *color);
86 guint16    gtk_color_button_get_alpha      (GtkColorButton *color_button);
87 void       gtk_color_button_set_use_alpha  (GtkColorButton *color_button,
88                                             gboolean        use_alpha);
89 gboolean   gtk_color_button_get_use_alpha  (GtkColorButton *color_button);
90 void       gtk_color_button_set_rgba       (GtkColorButton *color_button,
91                                             const GdkRGBA  *rgba);
92 void       gtk_color_button_get_rgba       (GtkColorButton *color_button,
93                                             GdkRGBA        *rgba);
94 void       gtk_color_button_set_title      (GtkColorButton *color_button,
95                                             const gchar    *title);
96 G_CONST_RETURN gchar *gtk_color_button_get_title (GtkColorButton *color_button);
97
98
99 G_END_DECLS
100
101 #endif  /* __GTK_COLOR_BUTTON_H__ */