]> Pileus Git - ~andy/gtk/blob - gtk/gtkbutton.h
Add deprecation annotations for deprecated functions
[~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_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/gtkimage.h>
37
38
39 G_BEGIN_DECLS
40
41 #define GTK_TYPE_BUTTON                 (gtk_button_get_type ())
42 #define GTK_BUTTON(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_BUTTON, GtkButton))
43 #define GTK_BUTTON_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_BUTTON, GtkButtonClass))
44 #define GTK_IS_BUTTON(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_BUTTON))
45 #define GTK_IS_BUTTON_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_BUTTON))
46 #define GTK_BUTTON_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_BUTTON, GtkButtonClass))
47
48 typedef struct _GtkButton             GtkButton;
49 typedef struct _GtkButtonPrivate      GtkButtonPrivate;
50 typedef struct _GtkButtonClass        GtkButtonClass;
51
52 struct _GtkButton
53 {
54   /*< private >*/
55   GtkBin bin;
56
57   GtkButtonPrivate *priv;
58 };
59
60 struct _GtkButtonClass
61 {
62   GtkBinClass        parent_class;
63   
64   void (* pressed)  (GtkButton *button);
65   void (* released) (GtkButton *button);
66   void (* clicked)  (GtkButton *button);
67   void (* enter)    (GtkButton *button);
68   void (* leave)    (GtkButton *button);
69   void (* activate) (GtkButton *button);
70   
71   /* Padding for future expansion */
72   void (*_gtk_reserved1) (void);
73   void (*_gtk_reserved2) (void);
74   void (*_gtk_reserved3) (void);
75   void (*_gtk_reserved4) (void);
76 };
77
78
79 GType          gtk_button_get_type          (void) G_GNUC_CONST;
80 GtkWidget*     gtk_button_new               (void);
81 GtkWidget*     gtk_button_new_with_label    (const gchar    *label);
82 GtkWidget*     gtk_button_new_from_stock    (const gchar    *stock_id);
83 GtkWidget*     gtk_button_new_with_mnemonic (const gchar    *label);
84 void           gtk_button_clicked           (GtkButton      *button);
85 #ifndef GTK_DISABLE_DEPRECATED
86 GDK_DEPRECATED
87 void           gtk_button_pressed           (GtkButton      *button);
88 GDK_DEPRECATED
89 void           gtk_button_released          (GtkButton      *button);
90 GDK_DEPRECATED
91 void           gtk_button_enter             (GtkButton      *button);
92 GDK_DEPRECATED
93 void           gtk_button_leave             (GtkButton      *button);
94 #endif
95
96 void                  gtk_button_set_relief         (GtkButton      *button,
97                                                      GtkReliefStyle  newstyle);
98 GtkReliefStyle        gtk_button_get_relief         (GtkButton      *button);
99 void                  gtk_button_set_label          (GtkButton      *button,
100                                                      const gchar    *label);
101 const gchar *         gtk_button_get_label          (GtkButton      *button);
102 void                  gtk_button_set_use_underline  (GtkButton      *button,
103                                                      gboolean        use_underline);
104 gboolean              gtk_button_get_use_underline  (GtkButton      *button);
105 void                  gtk_button_set_use_stock      (GtkButton      *button,
106                                                      gboolean        use_stock);
107 gboolean              gtk_button_get_use_stock      (GtkButton      *button);
108 void                  gtk_button_set_focus_on_click (GtkButton      *button,
109                                                      gboolean        focus_on_click);
110 gboolean              gtk_button_get_focus_on_click (GtkButton      *button);
111 void                  gtk_button_set_alignment      (GtkButton      *button,
112                                                      gfloat          xalign,
113                                                      gfloat          yalign);
114 void                  gtk_button_get_alignment      (GtkButton      *button,
115                                                      gfloat         *xalign,
116                                                      gfloat         *yalign);
117 void                  gtk_button_set_image          (GtkButton      *button,
118                                                      GtkWidget      *image);
119 GtkWidget*            gtk_button_get_image          (GtkButton      *button);
120 void                  gtk_button_set_image_position (GtkButton      *button,
121                                                      GtkPositionType position);
122 GtkPositionType       gtk_button_get_image_position (GtkButton      *button);
123
124 GdkWindow*            gtk_button_get_event_window   (GtkButton      *button);
125
126
127 G_END_DECLS
128
129 #endif /* __GTK_BUTTON_H__ */