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-2000.  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 #ifndef GTK_DISABLE_DEPRECATED
28 
29 #ifndef __GTK_TOOLTIPS_H__
30 #define __GTK_TOOLTIPS_H__
31 
32 #include <gtk/gtkwidget.h>
33 #include <gtk/gtkwindow.h>
34 
35 
36 G_BEGIN_DECLS
37 
38 #define GTK_TYPE_TOOLTIPS                  (gtk_tooltips_get_type ())
39 #define GTK_TOOLTIPS(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLTIPS, GtkTooltips))
40 #define GTK_TOOLTIPS_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLTIPS, GtkTooltipsClass))
41 #define GTK_IS_TOOLTIPS(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLTIPS))
42 #define GTK_IS_TOOLTIPS_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLTIPS))
43 #define GTK_TOOLTIPS_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLTIPS, GtkTooltipsClass))
44 
45 
46 typedef struct _GtkTooltips	 GtkTooltips;
47 typedef struct _GtkTooltipsClass GtkTooltipsClass;
48 typedef struct _GtkTooltipsData	 GtkTooltipsData;
49 
50 struct _GtkTooltipsData
51 {
52   GtkTooltips *tooltips;
53   GtkWidget *widget;
54   gchar *tip_text;
55   gchar *tip_private;
56 };
57 
58 struct _GtkTooltips
59 {
60   GtkObject parent_instance;
61 
62   /*< private >*/
63   GtkWidget *tip_window;
64   GtkWidget *tip_label;
65   GtkTooltipsData *active_tips_data;
66   GList *tips_data_list; /* unused */
67 
68   guint   delay : 30;
69   guint	  enabled : 1;
70   guint   have_grab : 1;
71   guint   use_sticky_delay : 1;
72   gint	  timer_tag;
73   GTimeVal last_popdown;
74 };
75 
76 struct _GtkTooltipsClass
77 {
78   GtkObjectClass parent_class;
79 
80   /* Padding for future expansion */
81   void (*_gtk_reserved1) (void);
82   void (*_gtk_reserved2) (void);
83   void (*_gtk_reserved3) (void);
84   void (*_gtk_reserved4) (void);
85 };
86 
87 GType		 gtk_tooltips_get_type	   (void) G_GNUC_CONST;
88 GtkTooltips*	 gtk_tooltips_new	   (void);
89 
90 void		 gtk_tooltips_enable	   (GtkTooltips   *tooltips);
91 void		 gtk_tooltips_disable	   (GtkTooltips   *tooltips);
92 void		 gtk_tooltips_set_delay	   (GtkTooltips   *tooltips,
93 					    guint	   delay);
94 void		 gtk_tooltips_set_tip	   (GtkTooltips   *tooltips,
95 					    GtkWidget	  *widget,
96 					    const gchar   *tip_text,
97 					    const gchar   *tip_private);
98 GtkTooltipsData* gtk_tooltips_data_get	   (GtkWidget	  *widget);
99 void             gtk_tooltips_force_window (GtkTooltips   *tooltips);
100 
101 gboolean         gtk_tooltips_get_info_from_tip_window (GtkWindow    *tip_window,
102                                                         GtkTooltips **tooltips,
103                                                         GtkWidget   **current_widget);
104 
105 G_END_DECLS
106 
107 #endif /* __GTK_TOOLTIPS_H__ */
108 
109 #endif /* GTK_DISABLE_DEPRECATED */
110