]> Pileus Git - ~andy/gtk/blob - gtk/gtktooltip.h
Documentation and stylistic fixups
[~andy/gtk] / gtk / gtktooltip.h
1 /* gtktooltip.h
2  *
3  * Copyright (C) 2006-2007 Imendio AB
4  * Contact: Kristian Rietveld <kris@imendio.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
23 #error "Only <gtk/gtk.h> can be included directly."
24 #endif
25
26 #ifndef __GTK_TOOLTIP_H__
27 #define __GTK_TOOLTIP_H__
28
29 #include <gtk/gtkwindow.h>
30
31 G_BEGIN_DECLS
32
33 #define GTK_TYPE_TOOLTIP                 (gtk_tooltip_get_type ())
34 #define GTK_TOOLTIP(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TOOLTIP, GtkTooltip))
35 #define GTK_IS_TOOLTIP(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLTIP))
36
37 GType gtk_tooltip_get_type (void);
38
39 void gtk_tooltip_set_markup              (GtkTooltip         *tooltip,
40                                           const gchar        *markup);
41 void gtk_tooltip_set_text                (GtkTooltip         *tooltip,
42                                           const gchar        *text);
43 void gtk_tooltip_set_icon                (GtkTooltip         *tooltip,
44                                           GdkPixbuf          *pixbuf);
45 void gtk_tooltip_set_icon_from_stock     (GtkTooltip         *tooltip,
46                                           const gchar        *stock_id,
47                                           GtkIconSize         size);
48 void gtk_tooltip_set_icon_from_icon_name (GtkTooltip         *tooltip,
49                                           const gchar        *icon_name,
50                                           GtkIconSize         size);
51 void gtk_tooltip_set_icon_from_gicon     (GtkTooltip         *tooltip,
52                                           GIcon              *gicon,
53                                           GtkIconSize         size);
54 void gtk_tooltip_set_custom              (GtkTooltip         *tooltip,
55                                           GtkWidget          *custom_widget);
56
57 void gtk_tooltip_set_tip_area            (GtkTooltip         *tooltip,
58                                           const GdkRectangle *rect);
59
60 void gtk_tooltip_trigger_tooltip_query   (GdkDisplay         *display);
61
62
63 void _gtk_tooltip_focus_in               (GtkWidget          *widget);
64 void _gtk_tooltip_focus_out              (GtkWidget          *widget);
65 void _gtk_tooltip_toggle_keyboard_mode   (GtkWidget          *widget);
66 void _gtk_tooltip_handle_event           (GdkEvent           *event);
67 void _gtk_tooltip_hide                   (GtkWidget          *widget);
68
69 G_END_DECLS
70
71 #endif /* __GTK_TOOLTIP_H__ */