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