]> Pileus Git - ~andy/gtk/blob - gtk/gtkcolorbutton.h
Doc formatting tweaks.
[~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 /* Color picker button for GNOME
22  *
23  * Author: Federico Mena <federico@nuclecu.unam.mx>
24  *
25  * Modified by the GTK+ Team and others 2003.  See the AUTHORS
26  * file for a list of people on the GTK+ Team.  See the ChangeLog
27  * files for a list of changes.  These files are distributed with
28  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
29  */
30
31 #ifndef __GTK_COLOR_BUTTON_H__
32 #define __GTK_COLOR_BUTTON_H__
33
34
35 #include <gtk/gtkbutton.h>
36
37 G_BEGIN_DECLS
38
39
40 /* The GtkColorSelectionButton widget is a simple color picker in a button.  
41  * The button displays a sample of the currently selected color.  When 
42  * the user clicks on the button, a color selection dialog pops up.  
43  * The color picker emits the "color_set" signal when the color is set.
44  */
45
46 #define GTK_TYPE_COLOR_BUTTON             (gtk_color_button_get_type ())
47 #define GTK_COLOR_BUTTON(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButton))
48 #define GTK_COLOR_BUTTON_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_COLOR_BUTTON, GtkColorButtonClass))
49 #define GTK_IS_COLOR_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_COLOR_BUTTON))
50 #define GTK_IS_COLOR_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_COLOR_BUTTON))
51 #define GTK_COLOR_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButtonClass))
52
53 typedef struct _GtkColorButton          GtkColorButton;
54 typedef struct _GtkColorButtonClass     GtkColorButtonClass;
55 typedef struct _GtkColorButtonPrivate   GtkColorButtonPrivate;
56
57 struct _GtkColorButton {
58   GtkButton button;
59
60   /*< private >*/
61
62   GtkColorButtonPrivate *priv;
63 };
64
65 struct _GtkColorButtonClass {
66   GtkButtonClass parent_class;
67   
68   void (* color_set) (GtkColorButton *cp);
69   
70   /* Padding for future expansion */
71   void (*_gtk_reserved1) (void);
72   void (*_gtk_reserved2) (void);
73   void (*_gtk_reserved3) (void);
74   void (*_gtk_reserved4) (void);
75 };
76
77
78 GType      gtk_color_button_get_type       (void) G_GNUC_CONST;
79 GtkWidget *gtk_color_button_new            (void);
80 GtkWidget *gtk_color_button_new_with_color (GdkColor       *color);
81 void       gtk_color_button_set_color      (GtkColorButton *color_button, 
82                                             GdkColor       *color);
83 void       gtk_color_button_set_alpha      (GtkColorButton *color_button,
84                                             guint16         alpha);
85 void       gtk_color_button_get_color      (GtkColorButton *color_button, 
86                                             GdkColor       *color);
87 guint16    gtk_color_button_get_alpha      (GtkColorButton *color_button);
88 void       gtk_color_button_set_use_alpha  (GtkColorButton *color_button, 
89                                             gboolean        use_alpha);
90 gboolean   gtk_color_button_get_use_alpha  (GtkColorButton *color_button);
91 void       gtk_color_button_set_title      (GtkColorButton *color_button, 
92                                             const gchar    *title);
93 G_CONST_RETURN gchar *gtk_color_button_get_title (GtkColorButton *color_button);
94
95
96 G_END_DECLS
97
98 #endif  /* __GTK_COLOR_BUTTON_H__ */
99
100
101
102