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/.
30 #include "gtkstatusbar.h"
32 #include "gtkboxprivate.h"
35 #include "gtkmarshalers.h"
36 #include "gtkwindow.h"
37 #include "gtkprivate.h"
39 #include "gtkbuildable.h"
40 #include "gtkorientable.h"
41 #include "gtktypebuiltins.h"
42 #include "a11y/gtkstatusbaraccessible.h"
45 * SECTION:gtkstatusbar
46 * @title: GtkStatusbar
47 * @short_description: Report messages of minor importance to the user
49 * A #GtkStatusbar is usually placed along the bottom of an application's
50 * main #GtkWindow. It may provide a regular commentary of the application's
51 * status (as is usually the case in a web browser, for example), or may be
52 * used to simply output a message when the status changes, (when an upload
53 * is complete in an FTP client, for example).
55 * Status bars in GTK+ maintain a stack of messages. The message at
56 * the top of the each bar's stack is the one that will currently be displayed.
58 * Any messages added to a statusbar's stack must specify a
59 * <emphasis>context id</emphasis> that is used to uniquely identify
60 * the source of a message. This context id can be generated by
61 * gtk_statusbar_get_context_id(), given a message and the statusbar that
62 * it will be added to. Note that messages are stored in a stack, and when
63 * choosing which message to display, the stack structure is adhered to,
64 * regardless of the context identifier of a message.
66 * One could say that a statusbar maintains one stack of messages for
67 * display purposes, but allows multiple message producers to maintain
68 * sub-stacks of the messages they produced (via context ids).
70 * Status bars are created using gtk_statusbar_new().
72 * Messages are added to the bar's stack with gtk_statusbar_push().
74 * The message at the top of the stack can be removed using
75 * gtk_statusbar_pop(). A message can be removed from anywhere in the
76 * stack if its message id was recorded at the time it was added. This
77 * is done using gtk_statusbar_remove().
79 typedef struct _GtkStatusbarMsg GtkStatusbarMsg;
81 struct _GtkStatusbarPrivate
94 struct _GtkStatusbarMsg
108 static void gtk_statusbar_buildable_interface_init (GtkBuildableIface *iface);
109 static GObject *gtk_statusbar_buildable_get_internal_child (GtkBuildable *buildable,
111 const gchar *childname);
112 static void gtk_statusbar_update (GtkStatusbar *statusbar,
115 static void gtk_statusbar_realize (GtkWidget *widget);
116 static void gtk_statusbar_destroy (GtkWidget *widget);
117 static void gtk_statusbar_size_allocate (GtkWidget *widget,
118 GtkAllocation *allocation);
119 static void gtk_statusbar_hierarchy_changed (GtkWidget *widget,
120 GtkWidget *previous_toplevel);
123 static guint statusbar_signals[SIGNAL_LAST] = { 0 };
125 G_DEFINE_TYPE_WITH_CODE (GtkStatusbar, gtk_statusbar, GTK_TYPE_BOX,
126 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
127 gtk_statusbar_buildable_interface_init));
130 gtk_statusbar_class_init (GtkStatusbarClass *class)
132 GtkWidgetClass *widget_class;
134 widget_class = (GtkWidgetClass *) class;
136 widget_class->realize = gtk_statusbar_realize;
137 widget_class->destroy = gtk_statusbar_destroy;
138 widget_class->size_allocate = gtk_statusbar_size_allocate;
139 widget_class->hierarchy_changed = gtk_statusbar_hierarchy_changed;
141 class->text_pushed = gtk_statusbar_update;
142 class->text_popped = gtk_statusbar_update;
145 * GtkStatusbar::text-pushed:
146 * @statusbar: the object which received the signal
147 * @context_id: the context id of the relevant message/statusbar
148 * @text: the message that was pushed
150 * Is emitted whenever a new message gets pushed onto a statusbar's stack.
152 statusbar_signals[SIGNAL_TEXT_PUSHED] =
153 g_signal_new (I_("text-pushed"),
154 G_OBJECT_CLASS_TYPE (class),
156 G_STRUCT_OFFSET (GtkStatusbarClass, text_pushed),
158 _gtk_marshal_VOID__UINT_STRING,
164 * GtkStatusbar::text-popped:
165 * @statusbar: the object which received the signal
166 * @context_id: the context id of the relevant message/statusbar
167 * @text: the message that was just popped
169 * Is emitted whenever a new message is popped off a statusbar's stack.
171 statusbar_signals[SIGNAL_TEXT_POPPED] =
172 g_signal_new (I_("text-popped"),
173 G_OBJECT_CLASS_TYPE (class),
175 G_STRUCT_OFFSET (GtkStatusbarClass, text_popped),
177 _gtk_marshal_VOID__UINT_STRING,
182 gtk_widget_class_install_style_property (widget_class,
183 g_param_spec_enum ("shadow-type",
185 P_("Style of bevel around the statusbar text"),
186 GTK_TYPE_SHADOW_TYPE,
188 GTK_PARAM_READABLE));
190 g_type_class_add_private (class, sizeof (GtkStatusbarPrivate));
192 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_STATUSBAR_ACCESSIBLE);
196 gtk_statusbar_init (GtkStatusbar *statusbar)
198 GtkStatusbarPrivate *priv;
199 GtkBox *box = GTK_BOX (statusbar);
200 GtkWidget *message_area;
201 GtkShadowType shadow_type;
203 statusbar->priv = G_TYPE_INSTANCE_GET_PRIVATE (statusbar,
205 GtkStatusbarPrivate);
206 priv = statusbar->priv;
208 gtk_widget_set_redraw_on_allocate (GTK_WIDGET (box), TRUE);
210 gtk_box_set_spacing (box, 2);
211 gtk_box_set_homogeneous (box, FALSE);
213 gtk_widget_style_get (GTK_WIDGET (statusbar), "shadow-type", &shadow_type, NULL);
215 priv->frame = gtk_frame_new (NULL);
216 gtk_frame_set_shadow_type (GTK_FRAME (priv->frame), shadow_type);
217 gtk_box_pack_start (box, priv->frame, TRUE, TRUE, 0);
218 gtk_widget_show (priv->frame);
220 message_area = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 4);
221 gtk_container_add (GTK_CONTAINER (priv->frame), message_area);
222 gtk_widget_show (message_area);
224 priv->label = gtk_label_new ("");
225 gtk_label_set_single_line_mode (GTK_LABEL (priv->label), TRUE);
226 gtk_widget_set_halign (priv->label, GTK_ALIGN_START);
227 gtk_widget_set_valign (priv->label, GTK_ALIGN_CENTER);
228 gtk_label_set_ellipsize (GTK_LABEL (priv->label), PANGO_ELLIPSIZE_END);
229 gtk_container_add (GTK_CONTAINER (message_area), priv->label);
230 gtk_widget_show (priv->label);
232 priv->seq_context_id = 1;
233 priv->seq_message_id = 1;
234 priv->messages = NULL;
238 static GtkBuildableIface *parent_buildable_iface;
241 gtk_statusbar_buildable_interface_init (GtkBuildableIface *iface)
243 parent_buildable_iface = g_type_interface_peek_parent (iface);
244 iface->get_internal_child = gtk_statusbar_buildable_get_internal_child;
248 gtk_statusbar_buildable_get_internal_child (GtkBuildable *buildable,
250 const gchar *childname)
252 GtkStatusbar *statusbar = GTK_STATUSBAR (buildable);
253 GtkStatusbarPrivate *priv = statusbar->priv;
255 if (strcmp (childname, "message_area") == 0)
256 return G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->frame)));
258 return parent_buildable_iface->get_internal_child (buildable,
266 * Creates a new #GtkStatusbar ready for messages.
268 * Returns: the new #GtkStatusbar
271 gtk_statusbar_new (void)
273 return g_object_new (GTK_TYPE_STATUSBAR, NULL);
277 gtk_statusbar_update (GtkStatusbar *statusbar,
281 GtkStatusbarPrivate *priv;
283 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
285 priv = statusbar->priv;
290 gtk_label_set_text (GTK_LABEL (priv->label), text);
294 * gtk_statusbar_get_context_id:
295 * @statusbar: a #GtkStatusbar
296 * @context_description: textual description of what context
297 * the new message is being used in
299 * Returns a new context identifier, given a description
300 * of the actual context. Note that the description is
301 * <emphasis>not</emphasis> shown in the UI.
303 * Returns: an integer id
306 gtk_statusbar_get_context_id (GtkStatusbar *statusbar,
307 const gchar *context_description)
309 GtkStatusbarPrivate *priv;
313 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), 0);
314 g_return_val_if_fail (context_description != NULL, 0);
316 priv = statusbar->priv;
318 /* we need to preserve namespaces on object datas */
319 string = g_strconcat ("gtk-status-bar-context:", context_description, NULL);
321 id = GPOINTER_TO_UINT (g_object_get_data (G_OBJECT (statusbar), string));
324 id = priv->seq_context_id++;
325 g_object_set_data_full (G_OBJECT (statusbar), string, GUINT_TO_POINTER (id), NULL);
326 priv->keys = g_slist_prepend (priv->keys, string);
334 static GtkStatusbarMsg *
335 gtk_statusbar_msg_create (GtkStatusbar *statusbar,
339 GtkStatusbarMsg *msg;
341 msg = g_slice_new (GtkStatusbarMsg);
342 msg->text = g_strdup (text);
343 msg->context_id = context_id;
344 msg->message_id = statusbar->priv->seq_message_id++;
350 gtk_statusbar_msg_free (GtkStatusbarMsg *msg)
353 g_slice_free (GtkStatusbarMsg, msg);
357 * gtk_statusbar_push:
358 * @statusbar: a #GtkStatusbar
359 * @context_id: the message's context id, as returned by
360 * gtk_statusbar_get_context_id()
361 * @text: the message to add to the statusbar
363 * Pushes a new message onto a statusbar's stack.
365 * Returns: a message id that can be used with
366 * gtk_statusbar_remove().
369 gtk_statusbar_push (GtkStatusbar *statusbar,
373 GtkStatusbarPrivate *priv;
374 GtkStatusbarMsg *msg;
376 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), 0);
377 g_return_val_if_fail (text != NULL, 0);
379 priv = statusbar->priv;
381 msg = gtk_statusbar_msg_create (statusbar, context_id, text);
382 priv->messages = g_slist_prepend (priv->messages, msg);
384 g_signal_emit (statusbar,
385 statusbar_signals[SIGNAL_TEXT_PUSHED],
390 return msg->message_id;
395 * @statusbar: a #GtkStatusBar
396 * @context_id: a context identifier
398 * Removes the first message in the #GtkStatusBar's stack
399 * with the given context id.
401 * Note that this may not change the displayed message, if
402 * the message at the top of the stack has a different
406 gtk_statusbar_pop (GtkStatusbar *statusbar,
409 GtkStatusbarPrivate *priv;
410 GtkStatusbarMsg *msg;
412 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
414 priv = statusbar->priv;
420 for (list = priv->messages; list; list = list->next)
424 if (msg->context_id == context_id)
426 priv->messages = g_slist_remove_link (priv->messages, list);
427 gtk_statusbar_msg_free (msg);
428 g_slist_free_1 (list);
434 msg = priv->messages ? priv->messages->data : NULL;
436 g_signal_emit (statusbar,
437 statusbar_signals[SIGNAL_TEXT_POPPED],
439 (guint) (msg ? msg->context_id : 0),
440 msg ? msg->text : NULL);
444 * gtk_statusbar_remove:
445 * @statusbar: a #GtkStatusBar
446 * @context_id: a context identifier
447 * @message_id: a message identifier, as returned by gtk_statusbar_push()
449 * Forces the removal of a message from a statusbar's stack.
450 * The exact @context_id and @message_id must be specified.
453 gtk_statusbar_remove (GtkStatusbar *statusbar,
457 GtkStatusbarPrivate *priv;
458 GtkStatusbarMsg *msg;
460 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
461 g_return_if_fail (message_id > 0);
463 priv = statusbar->priv;
465 msg = priv->messages ? priv->messages->data : NULL;
470 /* care about signal emission if the topmost item is removed */
471 if (msg->context_id == context_id &&
472 msg->message_id == message_id)
474 gtk_statusbar_pop (statusbar, context_id);
478 for (list = priv->messages; list; list = list->next)
482 if (msg->context_id == context_id &&
483 msg->message_id == message_id)
485 priv->messages = g_slist_remove_link (priv->messages, list);
486 gtk_statusbar_msg_free (msg);
487 g_slist_free_1 (list);
496 * gtk_statusbar_remove_all:
497 * @statusbar: a #GtkStatusBar
498 * @context_id: a context identifier
500 * Forces the removal of all messages from a statusbar's
501 * stack with the exact @context_id.
506 gtk_statusbar_remove_all (GtkStatusbar *statusbar,
509 GtkStatusbarPrivate *priv;
510 GtkStatusbarMsg *msg;
513 g_return_if_fail (GTK_IS_STATUSBAR (statusbar));
515 priv = statusbar->priv;
517 if (priv->messages == NULL)
520 msg = priv->messages->data;
522 /* care about signal emission if the topmost item is removed */
523 if (msg->context_id == context_id)
525 gtk_statusbar_pop (statusbar, context_id);
528 list = priv->messages;
532 prev = priv->messages;
540 if (msg->context_id == context_id)
543 priv->messages = list->next;
545 prev->next = list->next;
547 gtk_statusbar_msg_free (msg);
548 g_slist_free_1 (list);
551 prev = priv->messages;
567 * gtk_statusbar_get_message_area:
568 * @statusbar: a #GtkStatusBar
570 * Retrieves the box containing the label widget.
572 * Returns: (transfer none): a #GtkBox
577 gtk_statusbar_get_message_area (GtkStatusbar *statusbar)
579 GtkStatusbarPrivate *priv;
581 g_return_val_if_fail (GTK_IS_STATUSBAR (statusbar), NULL);
583 priv = statusbar->priv;
585 return gtk_bin_get_child (GTK_BIN (priv->frame));
589 gtk_statusbar_destroy (GtkWidget *widget)
591 GtkStatusbar *statusbar = GTK_STATUSBAR (widget);
592 GtkStatusbarPrivate *priv = statusbar->priv;
594 g_slist_free_full (priv->messages, (GDestroyNotify) gtk_statusbar_msg_free);
595 priv->messages = NULL;
597 g_slist_free_full (priv->keys, g_free);
600 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->destroy (widget);
603 /* look for extra children between the frame containing
604 * the label and where we want to draw the resize grip
607 has_extra_children (GtkStatusbar *statusbar)
609 GtkStatusbarPrivate *priv = statusbar->priv;
610 GtkPackType child_pack_type, frame_pack_type;
611 GtkWidget *child, *frame;
613 gboolean retval = FALSE;
616 children = _gtk_box_get_children (GTK_BOX (statusbar));
617 for (l = children; l; l = l->next)
621 if (frame == priv->frame)
625 gtk_box_query_child_packing (GTK_BOX (statusbar), frame,
626 NULL, NULL, NULL, &frame_pack_type);
628 for (l = l->next; l; l = l->next)
632 if (!gtk_widget_get_visible (child))
635 gtk_box_query_child_packing (GTK_BOX (statusbar), child,
636 NULL, NULL, NULL, &child_pack_type);
638 if (frame_pack_type == GTK_PACK_START || child_pack_type == GTK_PACK_END)
645 g_list_free (children);
651 gtk_statusbar_size_allocate (GtkWidget *widget,
652 GtkAllocation *allocation)
654 GtkStatusbar *statusbar = GTK_STATUSBAR (widget);
655 GtkStatusbarPrivate *priv = statusbar->priv;
656 gboolean extra_children = FALSE;
657 gboolean has_resize_grip = FALSE;
661 GdkRectangle translated_rect;
663 window = gtk_widget_get_toplevel (widget);
665 if (GTK_IS_WINDOW (window) &&
666 gtk_window_resize_grip_is_visible (GTK_WINDOW (window)))
668 gtk_window_get_resize_grip_area (GTK_WINDOW (window), &rect);
669 if (gtk_widget_translate_coordinates (gtk_widget_get_parent (widget),
676 translated_rect.x = x;
677 translated_rect.y = y;
678 translated_rect.width = allocation->width;
679 translated_rect.height = allocation->height;
681 if (gdk_rectangle_intersect (&rect, &translated_rect, NULL))
683 has_resize_grip = TRUE;
684 extra_children = has_extra_children (statusbar);
686 /* If there are extra children, we don't want them to occupy
687 * the space where we draw the resize grip, so we temporarily
688 * shrink the allocation.
689 * If there are no extra children, we want the frame to get
690 * the full allocation, and we fix up the allocation of the
691 * label afterwards to make room for the grip.
695 allocation->width -= rect.width;
696 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
697 allocation->x += rect.width;
703 /* chain up normally */
704 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->size_allocate (widget, allocation);
710 allocation->width += rect.width;
711 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
712 allocation->x -= rect.width;
714 gtk_widget_set_allocation (widget, allocation);
718 GtkAllocation child_allocation, frame_allocation;
721 /* Use the frame's child instead of statusbar->label directly, in case
722 * the label has been replaced by a container as the frame's child
723 * (and the label reparented into that container).
725 child = gtk_bin_get_child (GTK_BIN (priv->frame));
727 gtk_widget_get_allocation (child, &child_allocation);
728 gtk_widget_get_allocation (priv->frame, &frame_allocation);
729 if (child_allocation.width + rect.width > frame_allocation.width)
731 /* shrink the label to make room for the grip */
732 *allocation = child_allocation;
733 allocation->width = MAX (1, allocation->width - rect.width);
734 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
735 allocation->x += child_allocation.width - allocation->width;
737 gtk_widget_size_allocate (child, allocation);
744 resize_grip_visible_changed (GObject *object,
748 GtkStatusbar *statusbar = GTK_STATUSBAR (user_data);
749 GtkStatusbarPrivate *priv = statusbar->priv;
751 gtk_widget_queue_resize (priv->label);
752 gtk_widget_queue_resize (priv->frame);
753 gtk_widget_queue_resize (GTK_WIDGET (statusbar));
757 gtk_statusbar_hierarchy_changed (GtkWidget *widget,
758 GtkWidget *previous_toplevel)
762 if (previous_toplevel)
763 g_signal_handlers_disconnect_by_func (previous_toplevel,
764 G_CALLBACK (resize_grip_visible_changed),
766 window = gtk_widget_get_toplevel (widget);
767 if (GTK_IS_WINDOW (window))
768 g_signal_connect (window, "notify::resize-grip-visible",
769 G_CALLBACK (resize_grip_visible_changed), widget);
771 resize_grip_visible_changed (NULL, NULL, widget);
775 gtk_statusbar_realize (GtkWidget *widget)
777 GTK_WIDGET_CLASS (gtk_statusbar_parent_class)->realize (widget);
779 resize_grip_visible_changed (NULL, NULL, widget);