1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/**
* @file pidgintooltip.h Pidgin Tooltip API
* @ingroup pidgin
*/
/* pidgin
*
* Pidgin is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PIDGIN_TOOLTIP_H_
#define _PIDGIN_TOOLTIP_H_
#include <gtk/gtk.h>
/**
* @param tipwindow The window for the tooltip.
* @param path The GtkTreePath representing the row under the cursor.
* @param userdata The userdata set during pidgin_tooltip_setup_for_treeview.
* @param w The value of this should be set to the desired width of the tooltip window.
* @param h The value of this should be set to the desired height of the tooltip window.
*
* @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise.
* @since 2.4.0
*/
typedef gboolean (*PidginTooltipCreateForTree)(GtkWidget *tipwindow,
GtkTreePath *path, gpointer userdata, int *w, int *h);
/**
* @param tipwindow The window for the tooltip.
* @param userdata The userdata set during pidgin_tooltip_show.
* @param w The value of this should be set to the desired width of the tooltip window.
* @param h The value of this should be set to the desired height of the tooltip window.
*
* @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise.
* @since 2.4.0
*/
typedef gboolean (*PidginTooltipCreate)(GtkWidget *tipwindow,
gpointer userdata, int *w, int *h);
/**
* @param tipwindow The window for the tooltip.
* @param userdata The userdata set during pidgin_tooltip_setup_for_treeview or pidgin_tooltip_show.
*
* @return @c TRUE if the tooltip was painted correctly, @c FALSE otherwise.
* @since 2.4.0
*/
typedef gboolean (*PidginTooltipPaint)(GtkWidget *tipwindow, gpointer userdata);
/**
* Setup tooltip drawing functions for a treeview.
*
* @param tree The treeview
* @param userdata The userdata to send to the callback functions
* @param create_cb Callback function to create the tooltip for a GtkTreePath
* @param paint_cb Callback function to paint the tooltip
*
* @return @c TRUE if the tooltip callbacks were setup correctly.
* @since 2.4.0
*/
gboolean pidgin_tooltip_setup_for_treeview(GtkWidget *tree, gpointer userdata,
PidginTooltipCreateForTree create_cb, PidginTooltipPaint paint_cb);
/**
* Setup tooltip drawing functions for any widget.
*
* @param widget The widget
* @param userdata The userdata to send to the callback functions
* @param create_cb Callback function to create the tooltip for the widget
* @param paint_cb Callback function to paint the tooltip
*
* @return @c TRUE if the tooltip callbacks were setup correctly.
* @since 2.4.0
*/
gboolean pidgin_tooltip_setup_for_widget(GtkWidget *widget, gpointer userdata,
PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb);
/**
* Destroy the tooltip.
* @since 2.4.0
*/
void pidgin_tooltip_destroy(void);
/**
* Create and show a tooltip.
*
* @param widget The widget the tooltip is for
* @param userdata The userdata to send to the callback functions
* @param create_cb Callback function to create the tooltip from the GtkTreePath
* @param paint_cb Callback function to paint the tooltip
*
* @since 2.4.0
*/
void pidgin_tooltip_show(GtkWidget *widget, gpointer userdata,
PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb);
#endif
|
