]> Pileus Git - ~andy/gtk/blob - gtk/gtkbutton.h
no need to include <gdk/gdk.h> in any widget header, it's included via
[~andy/gtk] / gtk / gtkbutton.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2001.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25  */
26
27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
29 #endif
30
31 #ifndef __GTK_BUTTON_H__
32 #define __GTK_BUTTON_H__
33
34
35 #include <gtk/gtkbin.h>
36 #include <gtk/gtkenums.h>
37 #include <gtk/gtkimage.h>
38
39
40 G_BEGIN_DECLS
41
42 #define GTK_TYPE_BUTTON                 (gtk_button_get_type ())
43 #define GTK_BUTTON(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BUTTON, GtkButton))
44 #define GTK_BUTTON_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BUTTON, GtkButtonClass))
45 #define GTK_IS_BUTTON(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUTTON))
46 #define GTK_IS_BUTTON_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BUTTON))
47 #define GTK_BUTTON_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BUTTON, GtkButtonClass))
48
49 typedef struct _GtkButton        GtkButton;
50 typedef struct _GtkButtonClass   GtkButtonClass;
51
52 struct _GtkButton
53 {
54   GtkBin bin;
55
56   GdkWindow *GSEAL (event_window);
57
58   gchar *GSEAL (label_text);
59
60   guint GSEAL (activate_timeout);
61
62   guint GSEAL (constructed) : 1;
63   guint GSEAL (in_button) : 1;
64   guint GSEAL (button_down) : 1;
65   guint GSEAL (relief) : 2;
66   guint GSEAL (use_underline) : 1;
67   guint GSEAL (use_stock) : 1;
68   guint GSEAL (depressed) : 1;
69   guint GSEAL (depress_on_activate) : 1;
70   guint GSEAL (focus_on_click) : 1;
71 };
72
73 struct _GtkButtonClass
74 {
75   GtkBinClass        parent_class;
76   
77   void (* pressed)  (GtkButton *button);
78   void (* released) (GtkButton *button);
79   void (* clicked)  (GtkButton *button);
80   void (* enter)    (GtkButton *button);
81   void (* leave)    (GtkButton *button);
82   void (* activate) (GtkButton *button);
83   
84   /* Padding for future expansion */
85   void (*_gtk_reserved1) (void);
86   void (*_gtk_reserved2) (void);
87   void (*_gtk_reserved3) (void);
88   void (*_gtk_reserved4) (void);
89 };
90
91
92 GType          gtk_button_get_type          (void) G_GNUC_CONST;
93 GtkWidget*     gtk_button_new               (void);
94 GtkWidget*     gtk_button_new_with_label    (const gchar    *label);
95 GtkWidget*     gtk_button_new_from_stock    (const gchar    *stock_id);
96 GtkWidget*     gtk_button_new_with_mnemonic (const gchar    *label);
97 void           gtk_button_pressed           (GtkButton      *button);
98 void           gtk_button_released          (GtkButton      *button);
99 void           gtk_button_clicked           (GtkButton      *button);
100 void           gtk_button_enter             (GtkButton      *button);
101 void           gtk_button_leave             (GtkButton      *button);
102
103 void                  gtk_button_set_relief         (GtkButton      *button,
104                                                      GtkReliefStyle  newstyle);
105 GtkReliefStyle        gtk_button_get_relief         (GtkButton      *button);
106 void                  gtk_button_set_label          (GtkButton      *button,
107                                                      const gchar    *label);
108 G_CONST_RETURN gchar *gtk_button_get_label          (GtkButton      *button);
109 void                  gtk_button_set_use_underline  (GtkButton      *button,
110                                                      gboolean        use_underline);
111 gboolean              gtk_button_get_use_underline  (GtkButton      *button);
112 void                  gtk_button_set_use_stock      (GtkButton      *button,
113                                                      gboolean        use_stock);
114 gboolean              gtk_button_get_use_stock      (GtkButton      *button);
115 void                  gtk_button_set_focus_on_click (GtkButton      *button,
116                                                      gboolean        focus_on_click);
117 gboolean              gtk_button_get_focus_on_click (GtkButton      *button);
118 void                  gtk_button_set_alignment      (GtkButton      *button,
119                                                      gfloat          xalign,
120                                                      gfloat          yalign);
121 void                  gtk_button_get_alignment      (GtkButton      *button,
122                                                      gfloat         *xalign,
123                                                      gfloat         *yalign);
124 void                  gtk_button_set_image          (GtkButton      *button,
125                                                      GtkWidget      *image);
126 GtkWidget*            gtk_button_get_image          (GtkButton      *button);
127 void                  gtk_button_set_image_position (GtkButton      *button,
128                                                      GtkPositionType position);
129 GtkPositionType       gtk_button_get_image_position (GtkButton      *button);
130
131 void _gtk_button_set_depressed             (GtkButton          *button,
132                                             gboolean            depressed);
133 void _gtk_button_paint                     (GtkButton          *button,
134                                             const GdkRectangle *area,
135                                             GtkStateType        state_type,
136                                             GtkShadowType       shadow_type,
137                                             const gchar        *main_detail,
138                                             const gchar        *default_detail);
139
140 G_END_DECLS
141
142 #endif /* __GTK_BUTTON_H__ */