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 <gdk/gdk.h>
  31 #include <gtk/gtkdata.h>
  32
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif /* __cplusplus */
  37
  38
  39 #define GTK_TYPE_TOOLTIPS                  (gtk_tooltips_get_type ())
  40 #define GTK_TOOLTIPS(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_TOOLTIPS, GtkTooltips))
  41 #define GTK_TOOLTIPS_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TOOLTIPS, GtkTooltipsClass))
  42 #define GTK_IS_TOOLTIPS(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_TOOLTIPS))
  43 #define GTK_IS_TOOLTIPS_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLTIPS))
  44 #define GTK_TOOLTIPS_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TOOLTIPS, GtkTooltipsClass))
  45
  46
  47 typedef struct _GtkTooltips      GtkTooltips;
  48 typedef struct _GtkTooltipsClass GtkTooltipsClass;
  49 typedef struct _GtkTooltipsData  GtkTooltipsData;
  50
  51 struct _GtkTooltipsData
  52 {
  53   GtkTooltips *tooltips;
  54   GtkWidget *widget;
  55   gchar *tip_text;
  56   gchar *tip_private;
  57 };
  58
  59 struct _GtkTooltips
  60 {
  61   GtkData data;
  62
  63   GtkWidget *tip_window;
  64   GtkWidget *tip_label;
  65   GtkTooltipsData *active_tips_data;
  66   GList *tips_data_list;
  67
  68   guint   delay : 30;
  69   guint   enabled : 1;
  70   gint    timer_tag;
  71 };
  72
  73 struct _GtkTooltipsClass
  74 {
  75   GtkDataClass parent_class;
  76 };
  77
  78 GtkType          gtk_tooltips_get_type     (void);
  79 GtkTooltips*     gtk_tooltips_new          (void);
  80
  81 void             gtk_tooltips_enable       (GtkTooltips   *tooltips);
  82 void             gtk_tooltips_disable      (GtkTooltips   *tooltips);
  83 void             gtk_tooltips_set_delay    (GtkTooltips   *tooltips,
  84                                             guint          delay);
  85 void             gtk_tooltips_set_tip      (GtkTooltips   *tooltips,
  86                                             GtkWidget     *widget,
  87                                             const gchar   *tip_text,
  88                                             const gchar   *tip_private);
  89 void             gtk_tooltips_set_colors   (GtkTooltips   *tooltips,
  90                                             GdkColor      *background,
  91                                             GdkColor      *foreground);
  92 GtkTooltipsData* gtk_tooltips_data_get     (GtkWidget     *widget);
  93 void             gtk_tooltips_force_window (GtkTooltips   *tooltips);
  94
  95
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif /* __cplusplus */
 100
 101
 102 #endif /* __GTK_TOOLTIPS_H__ */