]> Pileus Git - ~andy/gtk/blob - gtk/gtkbutton.h
Deprecate direct access to public variables in GtkButton.
[~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 <gdk/gdk.h>
36 #include <gtk/gtkbin.h>
37 #include <gtk/gtkenums.h>
38 #include <gtk/gtkimage.h>
39
40
41 G_BEGIN_DECLS
42
43 #define GTK_TYPE_BUTTON                 (gtk_button_get_type ())
44 #define GTK_BUTTON(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BUTTON, GtkButton))
45 #define GTK_BUTTON_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BUTTON, GtkButtonClass))
46 #define GTK_IS_BUTTON(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUTTON))
47 #define GTK_IS_BUTTON_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BUTTON))
48 #define GTK_BUTTON_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BUTTON, GtkButtonClass))
49
50 typedef struct _GtkButton        GtkButton;
51 typedef struct _GtkButtonClass   GtkButtonClass;
52
53 struct _GtkButton
54 {
55   GtkBin bin;
56
57   GdkWindow *event_window;
58
59   gchar *label_text;
60
61   guint activate_timeout;
62
63   guint GSEAL (constructed : 1);
64   guint GSEAL (in_button : 1);
65   guint GSEAL (button_down : 1);
66   guint GSEAL (relief : 2);
67   guint GSEAL (use_underline : 1);
68   guint GSEAL (use_stock : 1);
69   guint GSEAL (depressed : 1);
70   guint GSEAL (depress_on_activate : 1);
71   guint GSEAL (focus_on_click : 1);
72 };
73
74 struct _GtkButtonClass
75 {
76   GtkBinClass        parent_class;
77   
78   void (* pressed)  (GtkButton *button);
79   void (* released) (GtkButton *button);
80   void (* clicked)  (GtkButton *button);
81   void (* enter)    (GtkButton *button);
82   void (* leave)    (GtkButton *button);
83   void (* activate) (GtkButton *button);
84   
85   /* Padding for future expansion */
86   void (*_gtk_reserved1) (void);
87   void (*_gtk_reserved2) (void);
88   void (*_gtk_reserved3) (void);
89   void (*_gtk_reserved4) (void);
90 };
91
92
93 GType          gtk_button_get_type          (void) G_GNUC_CONST;
94 GtkWidget*     gtk_button_new               (void);
95 GtkWidget*     gtk_button_new_with_label    (const gchar    *label);
96 GtkWidget*     gtk_button_new_from_stock    (const gchar    *stock_id);
97 GtkWidget*     gtk_button_new_with_mnemonic (const gchar    *label);
98 void           gtk_button_pressed           (GtkButton      *button);
99 void           gtk_button_released          (GtkButton      *button);
100 void           gtk_button_clicked           (GtkButton      *button);
101 void           gtk_button_enter             (GtkButton      *button);
102 void           gtk_button_leave             (GtkButton      *button);
103
104 void                  gtk_button_set_relief         (GtkButton      *button,
105                                                      GtkReliefStyle  newstyle);
106 GtkReliefStyle        gtk_button_get_relief         (GtkButton      *button);
107 void                  gtk_button_set_label          (GtkButton      *button,
108                                                      const gchar    *label);
109 G_CONST_RETURN gchar *gtk_button_get_label          (GtkButton      *button);
110 void                  gtk_button_set_use_underline  (GtkButton      *button,
111                                                      gboolean        use_underline);
112 gboolean              gtk_button_get_use_underline  (GtkButton      *button);
113 void                  gtk_button_set_use_stock      (GtkButton      *button,
114                                                      gboolean        use_stock);
115 gboolean              gtk_button_get_use_stock      (GtkButton      *button);
116 void                  gtk_button_set_focus_on_click (GtkButton      *button,
117                                                      gboolean        focus_on_click);
118 gboolean              gtk_button_get_focus_on_click (GtkButton      *button);
119 void                  gtk_button_set_alignment      (GtkButton      *button,
120                                                      gfloat          xalign,
121                                                      gfloat          yalign);
122 void                  gtk_button_get_alignment      (GtkButton      *button,
123                                                      gfloat         *xalign,
124                                                      gfloat         *yalign);
125 void                  gtk_button_set_image          (GtkButton      *button,
126                                                      GtkWidget      *image);
127 GtkWidget*            gtk_button_get_image          (GtkButton      *button);
128 void                  gtk_button_set_image_position (GtkButton      *button,
129                                                      GtkPositionType position);
130 GtkPositionType       gtk_button_get_image_position (GtkButton      *button);
131
132 void _gtk_button_set_depressed             (GtkButton          *button,
133                                             gboolean            depressed);
134 void _gtk_button_paint                     (GtkButton          *button,
135                                             const GdkRectangle *area,
136                                             GtkStateType        state_type,
137                                             GtkShadowType       shadow_type,
138                                             const gchar        *main_detail,
139                                             const gchar        *default_detail);
140
141 G_END_DECLS
142
143 #endif /* __GTK_BUTTON_H__ */