plugins/document-manager/editor-tooltips.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., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, 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 __EDITOR_TOOLTIPS_H__
  28 #define __EDITOR_TOOLTIPS_H__
  29
  30 #include <gtk/gtkwidget.h>
  31
  32
  33 #define EDITOR_TYPE_TOOLTIPS                  (editor_tooltips_get_type ())
  34 #define EDITOR_TOOLTIPS(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), EDITOR_TYPE_TOOLTIPS, EditorTooltips))
  35 #define EDITOR_TOOLTIPS_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), EDITOR_TYPE_TOOLTIPS, EditorTooltipsClass))
  36 #define EDITOR_IS_TOOLTIPS(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EDITOR_TYPE_TOOLTIPS))
  37 #define EDITOR_IS_TOOLTIPS_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), EDITOR_TYPE_TOOLTIPS))
  38 #define EDITOR_TOOLTIPS_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), EDITOR_TYPE_TOOLTIPS, EditorTooltipsClass))
  39
  40
  41 typedef struct _EditorTooltips EditorTooltips;
  42 typedef struct _EditorTooltipsClass EditorTooltipsClass;
  43 typedef struct _EditorTooltipsData EditorTooltipsData;
  44
  45 struct _EditorTooltipsData {
  46         EditorTooltips *tooltips;
  47         GtkWidget *widget;
  48         gchar *tip_text;
  49         gchar *tip_private;
  50 };
  51
  52 struct _EditorTooltips {
  53         GtkObject parent_instance;
  54
  55         GtkWidget *tip_window;
  56         GtkWidget *tip_label;
  57         EditorTooltipsData *active_tips_data;
  58         GList *tips_data_list;
  59
  60         guint delay:30;
  61         guint enabled:1;
  62         guint have_grab:1;
  63         guint use_sticky_delay:1;
  64         gint timer_tag;
  65         GTimeVal last_popdown;
  66 };
  67
  68 struct _EditorTooltipsClass {
  69         GtkObjectClass parent_class;
  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 GType editor_tooltips_get_type (void) G_GNUC_CONST;
  79 EditorTooltips *editor_tooltips_new (void);
  80
  81 void editor_tooltips_enable (EditorTooltips * tooltips);
  82 void editor_tooltips_disable (EditorTooltips * tooltips);
  83
  84 void editor_tooltips_set_tip (EditorTooltips * tooltips,
  85                              GtkWidget * widget,
  86                              const gchar * tip_text,
  87                              const gchar * tip_private);
  88
  89 EditorTooltipsData *editor_tooltips_data_get (GtkWidget * widget);
  90 void editor_tooltips_force_window (EditorTooltips * tooltips);
  91
  92 void _editor_tooltips_toggle_keyboard_mode (GtkWidget * widget);
  93
  94 #endif                          /* __EDITOR_TOOLTIPS_H__ */