1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkQueryTips: Query onscreen widgets for their tooltips
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtktipsquery.h"
31 #include "gtksignal.h"
32 #include "gtktooltips.h"
34 #include "gtkmarshalers.h"
39 /* --- arguments --- */
54 SIGNAL_WIDGET_ENTERED,
55 SIGNAL_WIDGET_SELECTED,
59 /* --- prototypes --- */
60 static void gtk_tips_query_class_init (GtkTipsQueryClass *class);
61 static void gtk_tips_query_init (GtkTipsQuery *tips_query);
62 static void gtk_tips_query_destroy (GtkObject *object);
63 static gint gtk_tips_query_event (GtkWidget *widget,
65 static void gtk_tips_query_set_arg (GtkObject *object,
68 static void gtk_tips_query_get_arg (GtkObject *object,
71 static void gtk_tips_query_real_start_query (GtkTipsQuery *tips_query);
72 static void gtk_tips_query_real_stop_query (GtkTipsQuery *tips_query);
73 static void gtk_tips_query_widget_entered (GtkTipsQuery *tips_query,
75 const gchar *tip_text,
76 const gchar *tip_private);
79 /* --- variables --- */
80 static GtkLabelClass *parent_class = NULL;
81 static guint tips_query_signals[SIGNAL_LAST] = { 0 };
84 /* --- functions --- */
86 gtk_tips_query_get_type (void)
88 static GtkType tips_query_type = 0;
92 static const GtkTypeInfo tips_query_info =
95 sizeof (GtkTipsQuery),
96 sizeof (GtkTipsQueryClass),
97 (GtkClassInitFunc) gtk_tips_query_class_init,
98 (GtkObjectInitFunc) gtk_tips_query_init,
99 /* reserved_1 */ NULL,
100 /* reserved_2 */ NULL,
101 (GtkClassInitFunc) NULL,
104 tips_query_type = gtk_type_unique (gtk_label_get_type (), &tips_query_info);
107 return tips_query_type;
111 gtk_tips_query_class_init (GtkTipsQueryClass *class)
113 GtkObjectClass *object_class;
114 GtkWidgetClass *widget_class;
116 object_class = (GtkObjectClass*) class;
117 widget_class = (GtkWidgetClass*) class;
119 parent_class = gtk_type_class (gtk_label_get_type ());
122 object_class->set_arg = gtk_tips_query_set_arg;
123 object_class->get_arg = gtk_tips_query_get_arg;
124 object_class->destroy = gtk_tips_query_destroy;
126 widget_class->event = gtk_tips_query_event;
128 class->start_query = gtk_tips_query_real_start_query;
129 class->stop_query = gtk_tips_query_real_stop_query;
130 class->widget_entered = gtk_tips_query_widget_entered;
131 class->widget_selected = NULL;
133 gtk_object_add_arg_type ("GtkTipsQuery::emit_always", GTK_TYPE_BOOL, GTK_ARG_READWRITE, ARG_EMIT_ALWAYS);
134 gtk_object_add_arg_type ("GtkTipsQuery::caller", GTK_TYPE_WIDGET, GTK_ARG_READWRITE, ARG_CALLER);
135 gtk_object_add_arg_type ("GtkTipsQuery::label_inactive", GTK_TYPE_STRING, GTK_ARG_READWRITE, ARG_LABEL_INACTIVE);
136 gtk_object_add_arg_type ("GtkTipsQuery::label_no_tip", GTK_TYPE_STRING, GTK_ARG_READWRITE, ARG_LABEL_NO_TIP);
138 tips_query_signals[SIGNAL_START_QUERY] =
139 gtk_signal_new ("start_query",
141 GTK_CLASS_TYPE (object_class),
142 GTK_SIGNAL_OFFSET (GtkTipsQueryClass, start_query),
143 _gtk_marshal_VOID__VOID,
145 tips_query_signals[SIGNAL_STOP_QUERY] =
146 gtk_signal_new ("stop_query",
148 GTK_CLASS_TYPE (object_class),
149 GTK_SIGNAL_OFFSET (GtkTipsQueryClass, stop_query),
150 _gtk_marshal_VOID__VOID,
152 tips_query_signals[SIGNAL_WIDGET_ENTERED] =
153 gtk_signal_new ("widget_entered",
155 GTK_CLASS_TYPE (object_class),
156 GTK_SIGNAL_OFFSET (GtkTipsQueryClass, widget_entered),
157 _gtk_marshal_VOID__OBJECT_STRING_STRING,
162 tips_query_signals[SIGNAL_WIDGET_SELECTED] =
163 g_signal_new ("widget_selected",
164 G_TYPE_FROM_CLASS(object_class),
166 G_STRUCT_OFFSET(GtkTipsQueryClass, widget_selected),
167 _gtk_boolean_handled_accumulator, NULL,
168 _gtk_marshal_BOOLEAN__OBJECT_STRING_STRING_BOXED,
173 GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
177 gtk_tips_query_init (GtkTipsQuery *tips_query)
179 tips_query->emit_always = FALSE;
180 tips_query->in_query = FALSE;
181 tips_query->label_inactive = g_strdup ("");
182 tips_query->label_no_tip = g_strdup (_("--- No Tip ---"));
183 tips_query->caller = NULL;
184 tips_query->last_crossed = NULL;
185 tips_query->query_cursor = NULL;
187 gtk_label_set_text (GTK_LABEL (tips_query), tips_query->label_inactive);
191 gtk_tips_query_set_arg (GtkObject *object,
195 GtkTipsQuery *tips_query;
197 tips_query = GTK_TIPS_QUERY (object);
201 case ARG_EMIT_ALWAYS:
202 tips_query->emit_always = (GTK_VALUE_BOOL (*arg) != FALSE);
205 gtk_tips_query_set_caller (tips_query, GTK_WIDGET (GTK_VALUE_OBJECT (*arg)));
207 case ARG_LABEL_INACTIVE:
208 gtk_tips_query_set_labels (tips_query, GTK_VALUE_STRING (*arg), tips_query->label_no_tip);
210 case ARG_LABEL_NO_TIP:
211 gtk_tips_query_set_labels (tips_query, tips_query->label_inactive, GTK_VALUE_STRING (*arg));
219 gtk_tips_query_get_arg (GtkObject *object,
223 GtkTipsQuery *tips_query;
225 tips_query = GTK_TIPS_QUERY (object);
229 case ARG_EMIT_ALWAYS:
230 GTK_VALUE_BOOL (*arg) = tips_query->emit_always;
233 GTK_VALUE_OBJECT (*arg) = (GtkObject*) tips_query->caller;
235 case ARG_LABEL_INACTIVE:
236 GTK_VALUE_STRING (*arg) = g_strdup (tips_query->label_inactive);
238 case ARG_LABEL_NO_TIP:
239 GTK_VALUE_STRING (*arg) = g_strdup (tips_query->label_no_tip);
242 arg->type = GTK_TYPE_INVALID;
248 gtk_tips_query_destroy (GtkObject *object)
250 GtkTipsQuery *tips_query;
252 g_return_if_fail (GTK_IS_TIPS_QUERY (object));
254 tips_query = GTK_TIPS_QUERY (object);
256 if (tips_query->in_query)
257 gtk_tips_query_stop_query (tips_query);
259 gtk_tips_query_set_caller (tips_query, NULL);
261 g_free (tips_query->label_inactive);
262 tips_query->label_inactive = NULL;
263 g_free (tips_query->label_no_tip);
264 tips_query->label_no_tip = NULL;
266 if (GTK_OBJECT_CLASS (parent_class)->destroy)
267 (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
271 gtk_tips_query_new (void)
273 GtkTipsQuery *tips_query;
275 tips_query = gtk_type_new (gtk_tips_query_get_type ());
277 return GTK_WIDGET (tips_query);
281 gtk_tips_query_set_labels (GtkTipsQuery *tips_query,
282 const gchar *label_inactive,
283 const gchar *label_no_tip)
287 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
288 g_return_if_fail (label_inactive != NULL);
289 g_return_if_fail (label_no_tip != NULL);
291 old = tips_query->label_inactive;
292 tips_query->label_inactive = g_strdup (label_inactive);
294 old = tips_query->label_no_tip;
295 tips_query->label_no_tip = g_strdup (label_no_tip);
300 gtk_tips_query_set_caller (GtkTipsQuery *tips_query,
303 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
304 g_return_if_fail (tips_query->in_query == FALSE);
306 g_return_if_fail (GTK_IS_WIDGET (caller));
309 gtk_widget_ref (caller);
311 if (tips_query->caller)
312 gtk_widget_unref (tips_query->caller);
314 tips_query->caller = caller;
318 gtk_tips_query_start_query (GtkTipsQuery *tips_query)
320 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
321 g_return_if_fail (tips_query->in_query == FALSE);
322 g_return_if_fail (GTK_WIDGET_REALIZED (tips_query));
324 tips_query->in_query = TRUE;
325 gtk_signal_emit (GTK_OBJECT (tips_query), tips_query_signals[SIGNAL_START_QUERY]);
329 gtk_tips_query_stop_query (GtkTipsQuery *tips_query)
331 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
332 g_return_if_fail (tips_query->in_query == TRUE);
334 gtk_signal_emit (GTK_OBJECT (tips_query), tips_query_signals[SIGNAL_STOP_QUERY]);
335 tips_query->in_query = FALSE;
339 gtk_tips_query_real_start_query (GtkTipsQuery *tips_query)
343 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
345 tips_query->query_cursor = gdk_cursor_new_for_display (gtk_widget_get_display (GTK_WIDGET (tips_query)),
347 failure = gdk_pointer_grab (GTK_WIDGET (tips_query)->window,
349 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
350 GDK_ENTER_NOTIFY_MASK | GDK_LEAVE_NOTIFY_MASK,
352 tips_query->query_cursor,
356 gdk_cursor_unref (tips_query->query_cursor);
357 tips_query->query_cursor = NULL;
359 gtk_grab_add (GTK_WIDGET (tips_query));
363 gtk_tips_query_real_stop_query (GtkTipsQuery *tips_query)
365 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
367 gtk_grab_remove (GTK_WIDGET (tips_query));
368 if (tips_query->query_cursor)
370 gdk_display_pointer_ungrab (gtk_widget_get_display (GTK_WIDGET (tips_query)),
372 gdk_cursor_unref (tips_query->query_cursor);
373 tips_query->query_cursor = NULL;
375 if (tips_query->last_crossed)
377 gtk_widget_unref (tips_query->last_crossed);
378 tips_query->last_crossed = NULL;
381 gtk_label_set_text (GTK_LABEL (tips_query), tips_query->label_inactive);
385 gtk_tips_query_widget_entered (GtkTipsQuery *tips_query,
387 const gchar *tip_text,
388 const gchar *tip_private)
390 g_return_if_fail (GTK_IS_TIPS_QUERY (tips_query));
393 tip_text = tips_query->label_no_tip;
395 if (!g_str_equal (GTK_LABEL (tips_query)->label, (gchar*) tip_text))
396 gtk_label_set_text (GTK_LABEL (tips_query), tip_text);
400 gtk_tips_query_emit_widget_entered (GtkTipsQuery *tips_query,
403 GtkTooltipsData *tdata;
405 if (widget == (GtkWidget*) tips_query)
409 tdata = gtk_tooltips_data_get (widget);
413 if (!widget && tips_query->last_crossed)
415 gtk_signal_emit (GTK_OBJECT (tips_query),
416 tips_query_signals[SIGNAL_WIDGET_ENTERED],
420 gtk_widget_unref (tips_query->last_crossed);
421 tips_query->last_crossed = NULL;
423 else if (widget && widget != tips_query->last_crossed)
425 gtk_widget_ref (widget);
426 if (tdata || tips_query->emit_always)
427 gtk_signal_emit (GTK_OBJECT (tips_query),
428 tips_query_signals[SIGNAL_WIDGET_ENTERED],
430 tdata ? tdata->tip_text : NULL,
431 tdata ? tdata->tip_private : NULL);
432 if (tips_query->last_crossed)
433 gtk_widget_unref (tips_query->last_crossed);
434 tips_query->last_crossed = widget;
439 gtk_tips_query_event (GtkWidget *widget,
442 GtkTipsQuery *tips_query;
443 GtkWidget *event_widget;
444 gboolean event_handled;
446 g_return_val_if_fail (GTK_IS_TIPS_QUERY (widget), FALSE);
448 tips_query = GTK_TIPS_QUERY (widget);
449 if (!tips_query->in_query)
451 if (GTK_WIDGET_CLASS (parent_class)->event)
452 return GTK_WIDGET_CLASS (parent_class)->event (widget, event);
457 event_widget = gtk_get_event_widget (event);
459 event_handled = FALSE;
462 GdkWindow *pointer_window;
464 case GDK_LEAVE_NOTIFY:
466 pointer_window = gdk_window_get_pointer (event_widget->window, NULL, NULL, NULL);
468 pointer_window = NULL;
471 gdk_window_get_user_data (pointer_window, (gpointer*) &event_widget);
472 gtk_tips_query_emit_widget_entered (tips_query, event_widget);
473 event_handled = TRUE;
476 case GDK_ENTER_NOTIFY:
477 gtk_tips_query_emit_widget_entered (tips_query, event_widget);
478 event_handled = TRUE;
481 case GDK_BUTTON_PRESS:
482 case GDK_BUTTON_RELEASE:
485 if (event_widget == (GtkWidget*) tips_query ||
486 event_widget == tips_query->caller)
487 gtk_tips_query_stop_query (tips_query);
491 GtkTooltipsData *tdata;
494 tdata = gtk_tooltips_data_get (event_widget);
495 if (tdata || tips_query->emit_always)
496 gtk_signal_emit (GTK_OBJECT (tips_query),
497 tips_query_signals[SIGNAL_WIDGET_SELECTED],
499 tdata ? tdata->tip_text : NULL,
500 tdata ? tdata->tip_private : NULL,
505 gtk_tips_query_stop_query (tips_query);
508 event_handled = TRUE;
515 return event_handled;