Mercurial > pidgin.yaz

comparison pidgin/pidgintooltip.h @ 32687:02a2e8183b1d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clean the API documentation in preparation for 3.0.0 by removing all the old @since tags.
author andrew.victor@mxit.com
date Sun, 25 Sep 2011 18:56:58 +0000
parents f60ce471c174
children
comparison
equal deleted inserted replaced
32685:9d5b87e1a4d0 32687:02a2e8183b1d
34 * @param userdata The userdata set during pidgin_tooltip_setup_for_treeview. 34 * @param userdata The userdata set during pidgin_tooltip_setup_for_treeview.
35 * @param w The value of this should be set to the desired width of the tooltip window. 35 * @param w The value of this should be set to the desired width of the tooltip window.
36 * @param h The value of this should be set to the desired height of the tooltip window. 36 * @param h The value of this should be set to the desired height of the tooltip window.
37 * 37 *
38 * @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise. 38 * @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise.
39 * @since 2.4.0
40 */ 39 */
41 typedef gboolean (*PidginTooltipCreateForTree)(GtkWidget *tipwindow, 40 typedef gboolean (*PidginTooltipCreateForTree)(GtkWidget *tipwindow,
42 GtkTreePath *path, gpointer userdata, int *w, int *h); 41 GtkTreePath *path, gpointer userdata, int *w, int *h);
43 42
44 /** 43 /**
46 * @param userdata The userdata set during pidgin_tooltip_show. 45 * @param userdata The userdata set during pidgin_tooltip_show.
47 * @param w The value of this should be set to the desired width of the tooltip window. 46 * @param w The value of this should be set to the desired width of the tooltip window.
48 * @param h The value of this should be set to the desired height of the tooltip window. 47 * @param h The value of this should be set to the desired height of the tooltip window.
49 * 48 *
50 * @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise. 49 * @return @c TRUE if the tooltip was created correctly, @c FALSE otherwise.
51 * @since 2.4.0
52 */ 50 */
53 typedef gboolean (*PidginTooltipCreate)(GtkWidget *tipwindow, 51 typedef gboolean (*PidginTooltipCreate)(GtkWidget *tipwindow,
54 gpointer userdata, int *w, int *h); 52 gpointer userdata, int *w, int *h);
55 53
56 /** 54 /**
57 * @param tipwindow The window for the tooltip. 55 * @param tipwindow The window for the tooltip.
58 * @param userdata The userdata set during pidgin_tooltip_setup_for_treeview or pidgin_tooltip_show. 56 * @param userdata The userdata set during pidgin_tooltip_setup_for_treeview or pidgin_tooltip_show.
59 * 57 *
60 * @return @c TRUE if the tooltip was painted correctly, @c FALSE otherwise. 58 * @return @c TRUE if the tooltip was painted correctly, @c FALSE otherwise.
61 * @since 2.4.0
62 */ 59 */
63 typedef gboolean (*PidginTooltipPaint)(GtkWidget *tipwindow, gpointer userdata); 60 typedef gboolean (*PidginTooltipPaint)(GtkWidget *tipwindow, gpointer userdata);
64 61
65 /** 62 /**
66 * Setup tooltip drawing functions for a treeview. 63 * Setup tooltip drawing functions for a treeview.
69 * @param userdata The userdata to send to the callback functions 66 * @param userdata The userdata to send to the callback functions
70 * @param create_cb Callback function to create the tooltip for a GtkTreePath 67 * @param create_cb Callback function to create the tooltip for a GtkTreePath
71 * @param paint_cb Callback function to paint the tooltip 68 * @param paint_cb Callback function to paint the tooltip
72 * 69 *
73 * @return @c TRUE if the tooltip callbacks were setup correctly. 70 * @return @c TRUE if the tooltip callbacks were setup correctly.
74 * @since 2.4.0
75 */ 71 */
76 gboolean pidgin_tooltip_setup_for_treeview(GtkWidget *tree, gpointer userdata, 72 gboolean pidgin_tooltip_setup_for_treeview(GtkWidget *tree, gpointer userdata,
77 PidginTooltipCreateForTree create_cb, PidginTooltipPaint paint_cb); 73 PidginTooltipCreateForTree create_cb, PidginTooltipPaint paint_cb);
78 74
79 /** 75 /**
83 * @param userdata The userdata to send to the callback functions 79 * @param userdata The userdata to send to the callback functions
84 * @param create_cb Callback function to create the tooltip for the widget 80 * @param create_cb Callback function to create the tooltip for the widget
85 * @param paint_cb Callback function to paint the tooltip 81 * @param paint_cb Callback function to paint the tooltip
86 * 82 *
87 * @return @c TRUE if the tooltip callbacks were setup correctly. 83 * @return @c TRUE if the tooltip callbacks were setup correctly.
88 * @since 2.4.0
89 */ 84 */
90 gboolean pidgin_tooltip_setup_for_widget(GtkWidget *widget, gpointer userdata, 85 gboolean pidgin_tooltip_setup_for_widget(GtkWidget *widget, gpointer userdata,
91 PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb); 86 PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb);
92 87
93 /** 88 /**
94 * Destroy the tooltip. 89 * Destroy the tooltip.
95 * @since 2.4.0
96 */ 90 */
97 void pidgin_tooltip_destroy(void); 91 void pidgin_tooltip_destroy(void);
98 92
99 /** 93 /**
100 * Create and show a tooltip. 94 * Create and show a tooltip.
101 * 95 *
102 * @param widget The widget the tooltip is for 96 * @param widget The widget the tooltip is for
103 * @param userdata The userdata to send to the callback functions 97 * @param userdata The userdata to send to the callback functions
104 * @param create_cb Callback function to create the tooltip from the GtkTreePath 98 * @param create_cb Callback function to create the tooltip from the GtkTreePath
105 * @param paint_cb Callback function to paint the tooltip 99 * @param paint_cb Callback function to paint the tooltip
106 *
107 * @since 2.4.0
108 */ 100 */
109 void pidgin_tooltip_show(GtkWidget *widget, gpointer userdata, 101 void pidgin_tooltip_show(GtkWidget *widget, gpointer userdata,
110 PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb); 102 PidginTooltipCreate create_cb, PidginTooltipPaint paint_cb);
111 103
112 #endif 104 #endif