1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * GtkStatusbar Copyright (C) 1998 Shawn T. Amundson
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkmarshalers.h"
33 #include "gtkstatusbar.h"
34 #include "gtkwindow.h"
35 #include "gtkprivate.h"
37 #include "gtkbuildable.h"
38 #include "gtktypebuiltins.h"
41 * SECTION:gtkstatusbar
42 * @title: GtkStatusbar
43 * @short_description: Report messages of minor importance to the user
45 * A #GtkStatusbar is usually placed along the bottom of an application's
46 * main #GtkWindow. It may provide a regular commentary of the application's
47 * status (as is usually the case in a web browser, for example), or may be
48 * used to simply output a message when the status changes, (when an upload
49 * is complete in an FTP client, for example).
51 * Status bars in GTK+ maintain a stack of messages. The message at
52 * the top of the each bar's stack is the one that will currently be displayed.
54 * Any messages added to a statusbar's stack must specify a
55 * <emphasis>context id</emphasis> that is used to uniquely identify
56 * the source of a message. This context id can be generated by
57 * gtk_statusbar_get_context_id(), given a message and the statusbar that
58 * it will be added to. Note that messages are stored in a stack, and when
59 * choosing which message to display, the stack structure is adhered to,
60 * regardless of the context identifier of a message.
62 * One could say that a statusbar maintains one stack of messages for
63 * display purposes, but allows multiple message producers to maintain
64 * sub-stacks of the messages they produced (via context ids).
66 * Status bars are created using gtk_statusbar_new().
68 * Messages are added to the bar's stack with gtk_statusbar_push().
70 * The message at the top of the stack can be removed using
71 * gtk_statusbar_pop(). A message can be removed from anywhere in the
72 * stack if its message id was recorded at the time it was added. This
73 * is done using gtk_statusbar_remove().
75 typedef struct _GtkStatusbarMsg GtkStatusbarMsg;
77 struct _GtkStatusbarPrivate
90 struct _GtkStatusbarMsg
104 static void gtk_statusbar_buildable_interface_init (GtkBuildableIface *iface);
105 static GObject *gtk_statusbar_buildable_get_internal_child (GtkBuildable *buildable,
107 const gchar *childname);
108 static void gtk_statusbar_update (GtkStatusbar *statusbar,
111 static void gtk_statusbar_realize (GtkWidget *widget);
112 static void gtk_statusbar_destroy (GtkWidget *widget);
113 static void gtk_statusbar_size_allocate (GtkWidget *widget,
114 GtkAllocation *allocation);
115 static void gtk_statusbar_hierarchy_changed (GtkWidget *widget,
116 GtkWidget *previous_toplevel);
119 static guint statusbar_signals[SIGNAL_LAST] = { 0 };
121 G_DEFINE_TYPE_WITH_CODE (GtkStatusbar, gtk_statusbar, GTK_TYPE_HBOX,
122 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
123 gtk_statusbar_buildable_interface_init));
126 gtk_statusbar_class_init (GtkStatusbarClass *class)
128 GObjectClass *gobject_class;
129 GtkWidgetClass *widget_class;
131 gobject_class = (GObjectClass *) class;
132 widget_class = (GtkWidgetClass *) class;
134 widget_class->realize = gtk_statusbar_realize;
135 widget_class->destroy = gtk_statusbar_destroy;
136 widget_class->size_allocate = gtk_statusbar_size_allocate;
137 widget_class->hierarchy_changed = gtk_statusbar_hierarchy_changed;
139 class->text_pushed = gtk_statusbar_update;
140 class->text_popped = gtk_statusbar_update;
143 * GtkStatusbar::text-pushed:
144 * @statusbar: the object which received the signal.
145 * @context_id: the context id of the relevant message/statusbar.
146 * @text: the message that was pushed.
148 * Is emitted whenever a new message gets pushed onto a statusbar's stack.
150 statusbar_signals[SIGNAL_TEXT_PUSHED] =
151 g_signal_new (I_("text-pushed"),
152 G_OBJECT_CLASS_TYPE (class),
154 G_STRUCT_OFFSET (GtkStatusbarClass, text_pushed),
156 _gtk_marshal_VOID__UINT_STRING,
162 * GtkStatusbar::text-popped:
163 * @statusbar: the object which received the signal.
164 * @context_id: the context id of the relevant message/statusbar.
165 * @text: the message that was just popped.
167 * Is emitted whenever a new message is popped off a statusbar's stack.
169 statusbar_signals[SIGNAL_TEXT_POPPED] =
170 g_signal_new (I_("text-popped"),
171 G_OBJECT_CLASS_TYPE (class),
173 G_STRUCT_OFFSET (GtkStatusbarClass, text_popped),
175 _gtk_marshal_VOID__UINT_STRING,
180 gtk_widget_class_install_style_property (widget_class,
181 g_param_spec_enum ("shadow-type",
183 P_("Style of bevel around the statusbar text"),
184 GTK_TYPE_SHADOW_TYPE,
186 GTK_PARAM_READABLE));
188 g_type_class_add_private (class, sizeof (GtkStatusbarPrivate));
192 gtk_statusbar_init (GtkStatusbar *statusbar)
194 GtkStatusbarPrivate *priv;
195 GtkBox *box = GTK_BOX (statusbar);
196 GtkWidget *message_area;
197 GtkShadowType shadow_type;
199 statusbar->priv = G_TYPE_INSTANCE_GET_PRIVATE (statusbar,
201 GtkStatusbarPrivate);
202 priv = statusbar->priv;
204 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (box), TRUE);
206 gtk_box_set_spacing (box, 2);
207 gtk_box_set_homogeneous (box, FALSE);
209 gtk_widget_style_get (GTK_WIDGET (statusbar), "shadow-type", &shadow_type, NULL);
211 priv->frame = gtk_frame_new (NULL);
212 gtk_frame_set_shadow_type (GTK_FRAME (priv->frame), shadow_type);
213 gtk_box_pack_start (box, priv->frame, TRUE, TRUE, 0);
214 gtk_widget_show (priv->frame);
216 message_area = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 4);
217 gtk_container_add (GTK_CONTAINER (priv->frame), message_area);
218 gtk_widget_show (message_area);
220 priv->label = gtk_label_new ("");
221 gtk_label_set_single_line_mode (GTK_LABEL (priv->label), TRUE);
222 gtk_misc_set_alignment (GTK_MISC (priv->label), 0.0, 0.5);
223 gtk_label_set_ellipsize (GTK_LABEL (priv->label), PANGO_ELLIPSIZE_END);
224 gtk_container_add (GTK_CONTAINER (message_area), priv->label);
225 gtk_widget_show (priv->label);
227 priv->seq_context_id = 1;
228 priv->seq_message_id = 1;
229 priv->messages = NULL;
233 static GtkBuildableIface *parent_buildable_iface;
236 gtk_statusbar_buildable_interface_init (GtkBuildableIface *iface)
238 parent_buildable_iface = g_type_interface_peek_parent (iface);
239 iface->get_internal_child = gtk_statusbar_buildable_get_internal_child;
243 gtk_statusbar_buildable_get_internal_child (GtkBuildable *buildable,
245 const gchar *childname)
247 GtkStatusbar *statusbar = GTK_STATUSBAR (buildable);
248 GtkStatusbarPrivate *priv = statusbar->priv;
250 if (strcmp (childname, "message_area") == 0)
251 return G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->frame)));
253 return parent_buildable_iface->get_internal_child (buildable,
261 * Creates a new #GtkStatusbar ready for messages.
263 * Returns: the new #GtkStatusbar
266 gtk_statusbar_new (void)
268 return g_object_new (GTK_TYPE_STATUSBAR, NULL);
272 gtk_statusbar_update (GtkStatusbar *statusbar,
276 GtkStatusbarPrivate *priv;
278 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
280 priv = statusbar->priv;
285 gtk_label_set_text (GTK_LABEL (priv->label), text);
289 * gtk_statusbar_get_context_id:
290 * @statusbar: a #GtkStatusbar
291 * @context_description: textual description of what context
292 * the new message is being used in
294 * Returns a new context identifier, given a description
295 * of the actual context. Note that the description is
296 * <emphasis>not</emphasis> shown in the UI.
298 * Returns: an integer id
301 gtk_statusbar_get_context_id (GtkStatusbar *statusbar,
302 const gchar *context_description)
304 GtkStatusbarPrivate *priv;
308 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), 0);
309 g_return_val_if_fail (context_description != NULL, 0);
311 priv = statusbar->priv;
313 /* we need to preserve namespaces on object datas */
314 string = g_strconcat ("gtk-status-bar-context:", context_description, NULL);
316 id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (statusbar), string));
319 id = priv->seq_context_id++;
320 g_object_set_data_full (G_OBJECT (statusbar), string, GUINT_TO_POINTER (id), NULL);
321 priv->keys = g_slist_prepend (priv->keys, string);
330 * gtk_statusbar_push:
331 * @statusbar: a #GtkStatusbar
332 * @context_id: the message's context id, as returned by
333 * gtk_statusbar_get_context_id()
334 * @text: the message to add to the statusbar
336 * Pushes a new message onto a statusbar's stack.
338 * Returns: a message id that can be used with
339 * gtk_statusbar_remove().
342 gtk_statusbar_push (GtkStatusbar *statusbar,
346 GtkStatusbarPrivate *priv;
347 GtkStatusbarMsg *msg;
349 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), 0);
350 g_return_val_if_fail (text != NULL, 0);
352 priv = statusbar->priv;
354 msg = g_slice_new (GtkStatusbarMsg);
355 msg->text = g_strdup (text);
356 msg->context_id = context_id;
357 msg->message_id = priv->seq_message_id++;
359 priv->messages = g_slist_prepend (priv->messages, msg);
361 g_signal_emit (statusbar,
362 statusbar_signals[SIGNAL_TEXT_PUSHED],
367 return msg->message_id;
372 * @statusbar: a #GtkStatusBar
373 * @context_id: a context identifier
375 * Removes the first message in the #GtkStatusBar's stack
376 * with the given context id.
378 * Note that this may not change the displayed message, if
379 * the message at the top of the stack has a different
383 gtk_statusbar_pop (GtkStatusbar *statusbar,
386 GtkStatusbarPrivate *priv;
387 GtkStatusbarMsg *msg;
389 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
391 priv = statusbar->priv;
397 for (list = priv->messages; list; list = list->next)
401 if (msg->context_id == context_id)
403 priv->messages = g_slist_remove_link (priv->messages,
406 g_slice_free (GtkStatusbarMsg, msg);
407 g_slist_free_1 (list);
413 msg = priv->messages ? priv->messages->data : NULL;
415 g_signal_emit (statusbar,
416 statusbar_signals[SIGNAL_TEXT_POPPED],
418 (guint) (msg ? msg->context_id : 0),
419 msg ? msg->text : NULL);
423 * gtk_statusbar_remove:
424 * @statusbar: a #GtkStatusBar
425 * @context_id: a context identifier
426 * @message_id: a message identifier, as returned by gtk_statusbar_push()
428 * Forces the removal of a message from a statusbar's stack.
429 * The exact @context_id and @message_id must be specified.
432 gtk_statusbar_remove (GtkStatusbar *statusbar,
436 GtkStatusbarPrivate *priv;
437 GtkStatusbarMsg *msg;
439 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
440 g_return_if_fail (message_id > 0);
442 priv = statusbar->priv;
444 msg = priv->messages ? priv->messages->data : NULL;
449 /* care about signal emission if the topmost item is removed */
450 if (msg->context_id == context_id &&
451 msg->message_id == message_id)
453 gtk_statusbar_pop (statusbar, context_id);
457 for (list = priv->messages; list; list = list->next)
461 if (msg->context_id == context_id &&
462 msg->message_id == message_id)
464 priv->messages = g_slist_remove_link (priv->messages, list);
466 g_slice_free (GtkStatusbarMsg, msg);
467 g_slist_free_1 (list);
476 * gtk_statusbar_remove_all:
477 * @statusbar: a #GtkStatusBar
478 * @context_id: a context identifier
480 * Forces the removal of all messages from a statusbar's
481 * stack with the exact @context_id.
486 gtk_statusbar_remove_all (GtkStatusbar *statusbar,
489 GtkStatusbarPrivate *priv;
490 GtkStatusbarMsg *msg;
493 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
495 priv = statusbar->priv;
497 if (priv->messages == NULL)
500 msg = priv->messages->data;
502 /* care about signal emission if the topmost item is removed */
503 if (msg->context_id == context_id)
505 gtk_statusbar_pop (statusbar, context_id);
508 list = priv->messages;
512 prev = priv->messages;
520 if (msg->context_id == context_id)
523 priv->messages = list->next;
525 prev->next = list->next;
528 g_slice_free (GtkStatusbarMsg, msg);
529 g_slist_free_1 (list);
532 prev = priv->messages;
545 * gtk_statusbar_get_message_area:
546 * @statusbar: a #GtkStatusBar
548 * Retrieves the box containing the label widget.
550 * Returns: (transfer none): a #GtkBox
555 gtk_statusbar_get_message_area (GtkStatusbar *statusbar)
557 GtkStatusbarPrivate *priv;
559 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), NULL);
561 priv = statusbar->priv;
563 return gtk_bin_get_child (GTK_BIN (priv->frame));
567 gtk_statusbar_destroy (GtkWidget *widget)
569 GtkStatusbar *statusbar = GTK_STATUSBAR (widget);
570 GtkStatusbarPrivate *priv = statusbar->priv;
573 for (list = priv->messages; list; list = list->next)
575 GtkStatusbarMsg *msg;
579 g_slice_free (GtkStatusbarMsg, msg);
581 g_slist_free (priv->messages);
582 priv->messages = NULL;
584 for (list = priv->keys; list; list = list->next)
586 g_slist_free (priv->keys);
589 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->destroy (widget);
592 /* look for extra children between the frame containing
593 * the label and where we want to draw the resize grip
596 has_extra_children (GtkStatusbar *statusbar)
598 GtkStatusbarPrivate *priv = statusbar->priv;
599 GtkPackType child_pack_type, frame_pack_type;
600 GtkWidget *child, *frame;
602 gboolean retval = FALSE;
605 children = _gtk_box_get_children (GTK_BOX (statusbar));
606 for (l = children; l; l = l->next)
610 if (frame == priv->frame)
614 gtk_box_query_child_packing (GTK_BOX (statusbar), frame,
615 NULL, NULL, NULL, &frame_pack_type);
617 for (l = l->next; l; l = l->next)
621 if (!gtk_widget_get_visible (child))
624 gtk_box_query_child_packing (GTK_BOX (statusbar), child,
625 NULL, NULL, NULL, &child_pack_type);
627 if (frame_pack_type == GTK_PACK_START || child_pack_type == GTK_PACK_END)
634 g_list_free (children);
640 gtk_statusbar_size_allocate (GtkWidget *widget,
641 GtkAllocation *allocation)
643 GtkStatusbar *statusbar = GTK_STATUSBAR (widget);
644 GtkStatusbarPrivate *priv = statusbar->priv;
645 gboolean extra_children = FALSE;
646 gboolean has_resize_grip = FALSE;
650 GdkRectangle translated_rect;
652 window = gtk_widget_get_toplevel (widget);
654 if (GTK_IS_WINDOW (window) &&
655 gtk_window_resize_grip_is_visible (GTK_WINDOW (window)))
657 gtk_window_get_resize_grip_area (GTK_WINDOW (window), &rect);
658 if (gtk_widget_translate_coordinates (gtk_widget_get_parent (widget),
665 translated_rect.x = x;
666 translated_rect.y = y;
667 translated_rect.width = allocation->width;
668 translated_rect.height = allocation->height;
670 if (gdk_rectangle_intersect (&rect, &translated_rect, NULL))
672 has_resize_grip = TRUE;
673 extra_children = has_extra_children (statusbar);
675 /* If there are extra children, we don't want them to occupy
676 * the space where we draw the resize grip, so we temporarily
677 * shrink the allocation.
678 * If there are no extra children, we want the frame to get
679 * the full allocation, and we fix up the allocation of the
680 * label afterwards to make room for the grip.
684 allocation->width -= rect.width;
685 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
686 allocation->x += rect.width;
692 /* chain up normally */
693 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->size_allocate (widget, allocation);
699 allocation->width += rect.width;
700 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
701 allocation->x -= rect.width;
703 gtk_widget_set_allocation (widget, allocation);
707 GtkAllocation child_allocation, frame_allocation;
710 /* Use the frame's child instead of statusbar->label directly, in case
711 * the label has been replaced by a container as the frame's child
712 * (and the label reparented into that container).
714 child = gtk_bin_get_child (GTK_BIN (priv->frame));
716 gtk_widget_get_allocation (child, &child_allocation);
717 gtk_widget_get_allocation (priv->frame, &frame_allocation);
718 if (child_allocation.width + rect.width > frame_allocation.width)
720 /* shrink the label to make room for the grip */
721 *allocation = child_allocation;
722 allocation->width = MAX (1, allocation->width - rect.width);
723 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
724 allocation->x += child_allocation.width - allocation->width;
726 gtk_widget_size_allocate (child, allocation);
733 resize_grip_visible_changed (GObject *object,
737 GtkStatusbar *statusbar = GTK_STATUSBAR (user_data);
738 GtkStatusbarPrivate *priv = statusbar->priv;
740 gtk_widget_queue_resize (priv->label);
741 gtk_widget_queue_resize (priv->frame);
742 gtk_widget_queue_resize (GTK_WIDGET (statusbar));
746 gtk_statusbar_hierarchy_changed (GtkWidget *widget,
747 GtkWidget *previous_toplevel)
751 if (previous_toplevel)
752 g_signal_handlers_disconnect_by_func (previous_toplevel,
753 G_CALLBACK (resize_grip_visible_changed),
755 window = gtk_widget_get_toplevel (widget);
756 if (GTK_IS_WINDOW (window))
757 g_signal_connect (window, "notify::resize-grip-visible",
758 G_CALLBACK (resize_grip_visible_changed), widget);
760 resize_grip_visible_changed (NULL, NULL, widget);
764 gtk_statusbar_realize (GtkWidget *widget)
766 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->realize (widget);
768 resize_grip_visible_changed (NULL, NULL, widget);