1 /* Copyright (C) 2004 Red Hat, Inc.
3 This library is free software; you can redistribute it and/or
4 modify it under the terms of the GNU Library General Public License as
5 published by the Free Software Foundation; either version 2 of the
6 License, or (at your option) any later version.
8 This library is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 Library General Public License for more details.
13 You should have received a copy of the GNU Library General Public
14 License along with the Gnome Library; see the file COPYING.LIB. If not,
15 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 Boston, MA 02111-1307, USA.
23 #include <glib/gi18n.h>
25 #include <gdk/gdkkeysyms.h>
27 #include "eggfindbar.h"
29 struct _EggFindBarPrivate
33 GtkToolItem *next_button;
34 GtkToolItem *previous_button;
35 GtkToolItem *status_separator;
36 GtkToolItem *status_item;
37 GtkToolItem *case_button;
39 GtkWidget *find_entry;
40 GtkWidget *status_label;
42 gulong set_focus_handler;
43 guint case_sensitive : 1;
46 #define EGG_FIND_BAR_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EGG_TYPE_FIND_BAR, EggFindBarPrivate))
54 static void egg_find_bar_finalize (GObject *object);
55 static void egg_find_bar_get_property (GObject *object,
59 static void egg_find_bar_set_property (GObject *object,
63 static void egg_find_bar_show (GtkWidget *widget);
64 static void egg_find_bar_hide (GtkWidget *widget);
65 static void egg_find_bar_grab_focus (GtkWidget *widget);
67 G_DEFINE_TYPE (EggFindBar, egg_find_bar, GTK_TYPE_TOOLBAR);
78 static guint find_bar_signals[LAST_SIGNAL] = { 0 };
81 egg_find_bar_class_init (EggFindBarClass *klass)
83 GObjectClass *object_class;
84 GtkWidgetClass *widget_class;
85 GtkBindingSet *binding_set;
87 egg_find_bar_parent_class = g_type_class_peek_parent (klass);
89 object_class = (GObjectClass *)klass;
90 widget_class = (GtkWidgetClass *)klass;
92 object_class->set_property = egg_find_bar_set_property;
93 object_class->get_property = egg_find_bar_get_property;
95 object_class->finalize = egg_find_bar_finalize;
97 widget_class->show = egg_find_bar_show;
98 widget_class->hide = egg_find_bar_hide;
100 widget_class->grab_focus = egg_find_bar_grab_focus;
102 find_bar_signals[NEXT] =
103 g_signal_new ("next",
104 G_OBJECT_CLASS_TYPE (object_class),
106 G_STRUCT_OFFSET (EggFindBarClass, next),
108 g_cclosure_marshal_VOID__VOID,
110 find_bar_signals[PREVIOUS] =
111 g_signal_new ("previous",
112 G_OBJECT_CLASS_TYPE (object_class),
114 G_STRUCT_OFFSET (EggFindBarClass, previous),
116 g_cclosure_marshal_VOID__VOID,
118 find_bar_signals[CLOSE] =
119 g_signal_new ("close",
120 G_OBJECT_CLASS_TYPE (object_class),
121 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
122 G_STRUCT_OFFSET (EggFindBarClass, close),
124 g_cclosure_marshal_VOID__VOID,
126 find_bar_signals[SCROLL] =
127 g_signal_new ("scroll",
128 G_OBJECT_CLASS_TYPE (object_class),
129 G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
130 G_STRUCT_OFFSET (EggFindBarClass, scroll),
132 g_cclosure_marshal_VOID__ENUM,
134 GTK_TYPE_SCROLL_TYPE);
137 * EggFindBar:search_string:
139 * The current string to search for. NULL or empty string
140 * both mean no current string.
143 g_object_class_install_property (object_class,
145 g_param_spec_string ("search_string",
147 _("The name of the string to be found"),
152 * EggFindBar:case_sensitive:
154 * TRUE for a case sensitive search.
157 g_object_class_install_property (object_class,
159 g_param_spec_boolean ("case_sensitive",
161 _("TRUE for a case sensitive search"),
165 /* Style properties */
166 gtk_widget_class_install_style_property (widget_class,
167 g_param_spec_boxed ("all_matches_color",
168 _("Highlight color"),
169 _("Color of highlight for all matches"),
173 gtk_widget_class_install_style_property (widget_class,
174 g_param_spec_boxed ("current_match_color",
176 _("Color of highlight for the current match"),
180 g_type_class_add_private (object_class, sizeof (EggFindBarPrivate));
182 binding_set = gtk_binding_set_by_class (klass);
184 gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
187 gtk_binding_entry_add_signal (binding_set, GDK_Up, 0,
189 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_BACKWARD);
190 gtk_binding_entry_add_signal (binding_set, GDK_Down, 0,
192 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_FORWARD);
193 gtk_binding_entry_add_signal (binding_set, GDK_Page_Up, 0,
195 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_BACKWARD);
196 gtk_binding_entry_add_signal (binding_set, GDK_KP_Page_Up, 0,
198 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_BACKWARD);
199 gtk_binding_entry_add_signal (binding_set, GDK_Page_Down, 0,
201 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_FORWARD);
202 gtk_binding_entry_add_signal (binding_set, GDK_KP_Page_Down, 0,
204 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_FORWARD);
208 egg_find_bar_emit_next (EggFindBar *find_bar)
210 g_signal_emit (find_bar, find_bar_signals[NEXT], 0);
214 egg_find_bar_emit_previous (EggFindBar *find_bar)
216 g_signal_emit (find_bar, find_bar_signals[PREVIOUS], 0);
220 next_clicked_callback (GtkButton *button,
223 EggFindBar *find_bar = EGG_FIND_BAR (data);
225 egg_find_bar_emit_next (find_bar);
229 previous_clicked_callback (GtkButton *button,
232 EggFindBar *find_bar = EGG_FIND_BAR (data);
234 egg_find_bar_emit_previous (find_bar);
238 case_sensitive_toggled_callback (GtkCheckButton *button,
241 EggFindBar *find_bar = EGG_FIND_BAR (data);
243 egg_find_bar_set_case_sensitive (find_bar,
244 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)));
248 entry_activate_callback (GtkEntry *entry,
251 EggFindBar *find_bar = EGG_FIND_BAR (data);
253 if (find_bar->priv->search_string != NULL)
254 egg_find_bar_emit_next (find_bar);
258 entry_changed_callback (GtkEntry *entry,
261 EggFindBar *find_bar = EGG_FIND_BAR (data);
264 /* paranoid strdup because set_search_string() sets
267 text = g_strdup (gtk_entry_get_text (entry));
269 egg_find_bar_set_search_string (find_bar, text);
275 set_focus_cb (GtkWidget *window,
279 GtkWidget *wbar = GTK_WIDGET (bar);
281 while (widget != NULL && widget != wbar)
283 widget = widget->parent;
286 /* if widget == bar, the new focus widget is in the bar, so we
291 g_signal_emit (bar, find_bar_signals[CLOSE], 0);
296 egg_find_bar_init (EggFindBar *find_bar)
298 EggFindBarPrivate *priv;
300 GtkWidget *alignment;
306 priv = EGG_FIND_BAR_GET_PRIVATE (find_bar);
308 find_bar->priv = priv;
309 priv->search_string = NULL;
311 gtk_toolbar_set_style (GTK_TOOLBAR (find_bar), GTK_TOOLBAR_BOTH_HORIZ);
314 item = gtk_tool_item_new ();
315 box = gtk_hbox_new (FALSE, 12);
317 alignment = gtk_alignment_new (0.0, 0.5, 1.0, 0.0);
318 gtk_alignment_set_padding (GTK_ALIGNMENT (alignment), 0, 0, 2, 2);
320 label = gtk_label_new_with_mnemonic (_("Find:"));
322 priv->find_entry = gtk_entry_new ();
323 gtk_entry_set_width_chars (GTK_ENTRY (priv->find_entry), 32);
324 gtk_entry_set_max_length (GTK_ENTRY (priv->find_entry), 512);
325 gtk_label_set_mnemonic_widget (GTK_LABEL (label), priv->find_entry);
328 arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
329 priv->previous_button = gtk_tool_button_new (arrow, Q_("Find Pre_vious"));
330 gtk_tool_item_set_is_important (priv->previous_button, TRUE);
331 gtk_widget_set_tooltip_text (GTK_WIDGET (priv->previous_button),
332 _("Find previous occurrence of the search string"));
335 arrow = gtk_arrow_new (GTK_ARROW_RIGHT, GTK_SHADOW_NONE);
336 priv->next_button = gtk_tool_button_new (arrow, Q_("Find Ne_xt"));
337 gtk_tool_item_set_is_important (priv->next_button, TRUE);
338 gtk_widget_set_tooltip_text (GTK_WIDGET (priv->next_button),
339 _("Find next occurrence of the search string"));
342 priv->status_separator = gtk_separator_tool_item_new();
345 priv->case_button = gtk_toggle_tool_button_new ();
346 g_object_set (G_OBJECT (priv->case_button), "label", _("C_ase Sensitive"), NULL);
347 gtk_tool_item_set_is_important (priv->case_button, TRUE);
348 gtk_widget_set_tooltip_text (GTK_WIDGET (priv->case_button),
349 _("Toggle case sensitive search"));
352 priv->status_item = gtk_tool_item_new();
353 gtk_tool_item_set_expand (priv->status_item, TRUE);
354 priv->status_label = gtk_label_new (NULL);
355 gtk_label_set_ellipsize (GTK_LABEL (priv->status_label),
356 PANGO_ELLIPSIZE_END);
357 gtk_misc_set_alignment (GTK_MISC (priv->status_label), 0.0, 0.5);
360 g_signal_connect (priv->find_entry, "changed",
361 G_CALLBACK (entry_changed_callback),
363 g_signal_connect (priv->find_entry, "activate",
364 G_CALLBACK (entry_activate_callback),
366 g_signal_connect (priv->next_button, "clicked",
367 G_CALLBACK (next_clicked_callback),
369 g_signal_connect (priv->previous_button, "clicked",
370 G_CALLBACK (previous_clicked_callback),
372 g_signal_connect (priv->case_button, "toggled",
373 G_CALLBACK (case_sensitive_toggled_callback),
376 gtk_box_pack_start (GTK_BOX (box), label, FALSE, FALSE, 0);
377 gtk_box_pack_start (GTK_BOX (box), priv->find_entry, TRUE, TRUE, 0);
378 gtk_container_add (GTK_CONTAINER (alignment), box);
379 gtk_container_add (GTK_CONTAINER (item), alignment);
380 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), item, -1);
381 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), priv->previous_button, -1);
382 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), priv->next_button, -1);
383 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), priv->case_button, -1);
384 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), priv->status_separator, -1);
385 gtk_container_add (GTK_CONTAINER (priv->status_item), priv->status_label);
386 gtk_toolbar_insert (GTK_TOOLBAR (find_bar), priv->status_item, -1);
388 /* don't show status separator/label until they are set */
390 gtk_widget_show_all (GTK_WIDGET (item));
391 gtk_widget_show_all (GTK_WIDGET (priv->next_button));
392 gtk_widget_show_all (GTK_WIDGET (priv->previous_button));
393 gtk_widget_show (priv->status_label);
397 egg_find_bar_finalize (GObject *object)
399 EggFindBar *find_bar = EGG_FIND_BAR (object);
400 EggFindBarPrivate *priv = (EggFindBarPrivate *)find_bar->priv;
402 g_free (priv->search_string);
404 G_OBJECT_CLASS (egg_find_bar_parent_class)->finalize (object);
408 egg_find_bar_set_property (GObject *object,
413 EggFindBar *find_bar = EGG_FIND_BAR (object);
417 case PROP_SEARCH_STRING:
418 egg_find_bar_set_search_string (find_bar, g_value_get_string (value));
420 case PROP_CASE_SENSITIVE:
421 egg_find_bar_set_case_sensitive (find_bar, g_value_get_boolean (value));
424 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
430 egg_find_bar_get_property (GObject *object,
435 EggFindBar *find_bar = EGG_FIND_BAR (object);
436 EggFindBarPrivate *priv = (EggFindBarPrivate *)find_bar->priv;
440 case PROP_SEARCH_STRING:
441 g_value_set_string (value, priv->search_string);
443 case PROP_CASE_SENSITIVE:
444 g_value_set_boolean (value, priv->case_sensitive);
447 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
453 egg_find_bar_show (GtkWidget *widget)
455 EggFindBar *bar = EGG_FIND_BAR (widget);
456 EggFindBarPrivate *priv = bar->priv;
458 GTK_WIDGET_CLASS (egg_find_bar_parent_class)->show (widget);
460 if (priv->set_focus_handler == 0)
464 toplevel = gtk_widget_get_toplevel (widget);
466 priv->set_focus_handler =
467 g_signal_connect (toplevel, "set-focus",
468 G_CALLBACK (set_focus_cb), bar);
473 egg_find_bar_hide (GtkWidget *widget)
475 EggFindBar *bar = EGG_FIND_BAR (widget);
476 EggFindBarPrivate *priv = bar->priv;
478 if (priv->set_focus_handler != 0)
482 toplevel = gtk_widget_get_toplevel (widget);
484 g_signal_handlers_disconnect_by_func
485 (toplevel, (void (*)) G_CALLBACK (set_focus_cb), bar);
486 priv->set_focus_handler = 0;
489 GTK_WIDGET_CLASS (egg_find_bar_parent_class)->hide (widget);
493 egg_find_bar_grab_focus (GtkWidget *widget)
495 EggFindBar *find_bar = EGG_FIND_BAR (widget);
496 EggFindBarPrivate *priv = find_bar->priv;
498 gtk_widget_grab_focus (priv->find_entry);
504 * Creates a new #EggFindBar.
506 * Returns: a newly created #EggFindBar
511 egg_find_bar_new (void)
513 EggFindBar *find_bar;
515 find_bar = g_object_new (EGG_TYPE_FIND_BAR, NULL);
517 return GTK_WIDGET (find_bar);
521 * egg_find_bar_set_search_string:
523 * Sets the string that should be found/highlighted in the document.
524 * Empty string is converted to NULL.
529 egg_find_bar_set_search_string (EggFindBar *find_bar,
530 const char *search_string)
532 EggFindBarPrivate *priv;
534 g_return_if_fail (EGG_IS_FIND_BAR (find_bar));
536 priv = (EggFindBarPrivate *)find_bar->priv;
538 g_object_freeze_notify (G_OBJECT (find_bar));
540 if (priv->search_string != search_string)
544 old = priv->search_string;
546 if (search_string && *search_string == '\0')
547 search_string = NULL;
549 /* Only update if the string has changed; setting the entry
550 * will emit changed on the entry which will re-enter
551 * this function, but we'll handle that fine with this
554 if ((old && search_string == NULL) ||
555 (old == NULL && search_string) ||
556 (old && search_string &&
557 strcmp (old, search_string) != 0))
561 priv->search_string = g_strdup (search_string);
564 gtk_entry_set_text (GTK_ENTRY (priv->find_entry),
565 priv->search_string ?
566 priv->search_string :
569 not_empty = (search_string == NULL) ? FALSE : TRUE;
571 gtk_widget_set_sensitive (GTK_WIDGET (find_bar->priv->next_button), not_empty);
572 gtk_widget_set_sensitive (GTK_WIDGET (find_bar->priv->previous_button), not_empty);
574 g_object_notify (G_OBJECT (find_bar),
579 g_object_thaw_notify (G_OBJECT (find_bar));
584 * egg_find_bar_get_search_string:
586 * Gets the string that should be found/highlighted in the document.
588 * Returns: the string
593 egg_find_bar_get_search_string (EggFindBar *find_bar)
595 EggFindBarPrivate *priv;
597 g_return_val_if_fail (EGG_IS_FIND_BAR (find_bar), NULL);
599 priv = find_bar->priv;
601 return priv->search_string ? priv->search_string : "";
605 * egg_find_bar_set_case_sensitive:
607 * Sets whether the search is case sensitive
612 egg_find_bar_set_case_sensitive (EggFindBar *find_bar,
613 gboolean case_sensitive)
615 EggFindBarPrivate *priv;
617 g_return_if_fail (EGG_IS_FIND_BAR (find_bar));
619 priv = (EggFindBarPrivate *)find_bar->priv;
621 g_object_freeze_notify (G_OBJECT (find_bar));
623 case_sensitive = case_sensitive != FALSE;
625 if (priv->case_sensitive != case_sensitive)
627 priv->case_sensitive = case_sensitive;
629 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->case_button),
630 priv->case_sensitive);
632 g_object_notify (G_OBJECT (find_bar),
636 g_object_thaw_notify (G_OBJECT (find_bar));
640 * egg_find_bar_get_case_sensitive:
642 * Gets whether the search is case sensitive
644 * Returns: TRUE if it's case sensitive
649 egg_find_bar_get_case_sensitive (EggFindBar *find_bar)
651 EggFindBarPrivate *priv;
653 g_return_val_if_fail (EGG_IS_FIND_BAR (find_bar), FALSE);
655 priv = (EggFindBarPrivate *)find_bar->priv;
657 return priv->case_sensitive;
661 get_style_color (EggFindBar *find_bar,
662 const char *style_prop_name,
665 GdkColor *style_color;
667 gtk_widget_ensure_style (GTK_WIDGET (find_bar));
668 gtk_widget_style_get (GTK_WIDGET (find_bar),
669 "color", &style_color, NULL);
672 *color = *style_color;
673 gdk_color_free (style_color);
678 * egg_find_bar_get_all_matches_color:
680 * Gets the color to use to highlight all the
686 egg_find_bar_get_all_matches_color (EggFindBar *find_bar,
689 GdkColor found_color = { 0, 0, 0, 0x0f0f };
691 get_style_color (find_bar, "all_matches_color", &found_color);
693 *color = found_color;
697 * egg_find_bar_get_current_match_color:
699 * Gets the color to use to highlight the match
700 * we're currently on.
705 egg_find_bar_get_current_match_color (EggFindBar *find_bar,
708 GdkColor found_color = { 0, 0, 0, 0xffff };
710 get_style_color (find_bar, "current_match_color", &found_color);
712 *color = found_color;
716 * egg_find_bar_set_status_text:
718 * Sets some text to display if there's space; typical text would
719 * be something like "5 results on this page" or "No results"
721 * @text: the text to display
726 egg_find_bar_set_status_text (EggFindBar *find_bar,
729 EggFindBarPrivate *priv;
731 g_return_if_fail (EGG_IS_FIND_BAR (find_bar));
733 priv = (EggFindBarPrivate *)find_bar->priv;
735 gtk_label_set_text (GTK_LABEL (priv->status_label), text);
736 g_object_set (priv->status_separator, "visible", text != NULL && *text != '\0', NULL);
737 g_object_set (priv->status_item, "visible", text != NULL && *text !='\0', NULL);