diff options
Diffstat (limited to 'eel/eel-gtk-extensions.c')
| -rw-r--r-- | eel/eel-gtk-extensions.c | 456 |
1 files changed, 234 insertions, 222 deletions
diff --git a/eel/eel-gtk-extensions.c b/eel/eel-gtk-extensions.c index d694ad4f1..8b9a0d909 100644 --- a/eel/eel-gtk-extensions.c +++ b/eel/eel-gtk-extensions.c @@ -1,28 +1,27 @@ - /* eel-gtk-extensions.c - implementation of new functions that operate on - gtk classes. Perhaps some of these should be - rolled into gtk someday. - - Copyright (C) 1999, 2000, 2001 Eazel, Inc. - - The Gnome Library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public License as - published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. - - The Gnome Library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public - License along with the Gnome Library; see the file COPYING.LIB. If not, - see <http://www.gnu.org/licenses/>. - - Authors: John Sullivan <sullivan@eazel.com> - Ramiro Estrugo <ramiro@eazel.com> - Darin Adler <darin@eazel.com> -*/ + * gtk classes. Perhaps some of these should be + * rolled into gtk someday. + * + * Copyright (C) 1999, 2000, 2001 Eazel, Inc. + * + * The Gnome Library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * The Gnome Library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with the Gnome Library; see the file COPYING.LIB. If not, + * see <http://www.gnu.org/licenses/>. + * + * Authors: John Sullivan <sullivan@eazel.com> + * Ramiro Estrugo <ramiro@eazel.com> + * Darin Adler <darin@eazel.com> + */ #include <config.h> #include "eel-gtk-extensions.h" @@ -43,93 +42,95 @@ /* This number is fairly arbitrary. Long enough to show a pretty long * menu title, but not so long to make a menu grotesquely wide. */ -#define MAXIMUM_MENU_TITLE_LENGTH 48 +#define MAXIMUM_MENU_TITLE_LENGTH 48 /* Used for window position & size sanity-checking. The sizes are big enough to prevent - * at least normal-sized gnome panels from obscuring the window at the screen edges. + * at least normal-sized gnome panels from obscuring the window at the screen edges. */ -#define MINIMUM_ON_SCREEN_WIDTH 100 -#define MINIMUM_ON_SCREEN_HEIGHT 100 +#define MINIMUM_ON_SCREEN_WIDTH 100 +#define MINIMUM_ON_SCREEN_HEIGHT 100 /** * eel_gtk_window_get_geometry_string: * @window: a #GtkWindow - * + * * Obtains the geometry string for this window, suitable for * set_geometry_string(); assumes the window has NorthWest gravity - * + * * Return value: geometry string, must be freed **/ -char* +char * eel_gtk_window_get_geometry_string (GtkWindow *window) { - char *str; - int w, h, x, y; - - g_return_val_if_fail (GTK_IS_WINDOW (window), NULL); - g_return_val_if_fail (gtk_window_get_gravity (window) == - GDK_GRAVITY_NORTH_WEST, NULL); - - gtk_window_get_position (window, &x, &y); - gtk_window_get_size (window, &w, &h); - - str = g_strdup_printf ("%dx%d+%d+%d", w, h, x, y); - - return str; + char *str; + int w, h, x, y; + + g_return_val_if_fail (GTK_IS_WINDOW (window), NULL); + g_return_val_if_fail (gtk_window_get_gravity (window) == + GDK_GRAVITY_NORTH_WEST, NULL); + + gtk_window_get_position (window, &x, &y); + gtk_window_get_size (window, &w, &h); + + str = g_strdup_printf ("%dx%d+%d+%d", w, h, x, y); + + return str; } static void -sanity_check_window_position (int *left, int *top) +sanity_check_window_position (int *left, + int *top) { - g_assert (left != NULL); - g_assert (top != NULL); - - /* Make sure the top of the window is on screen, for - * draggability (might not be necessary with all window managers, - * but seems reasonable anyway). Make sure the top of the window - * isn't off the bottom of the screen, or so close to the bottom - * that it might be obscured by the panel. - */ - *top = CLAMP (*top, 0, gdk_screen_height() - MINIMUM_ON_SCREEN_HEIGHT); - - /* FIXME bugzilla.eazel.com 669: - * If window has negative left coordinate, set_uposition sends it - * somewhere else entirely. Not sure what level contains this bug (XWindows?). - * Hacked around by pinning the left edge to zero, which just means you - * can't set a window to be partly off the left of the screen using - * this routine. - */ - /* Make sure the left edge of the window isn't off the right edge of - * the screen, or so close to the right edge that it might be - * obscured by the panel. - */ - *left = CLAMP (*left, 0, gdk_screen_width() - MINIMUM_ON_SCREEN_WIDTH); + g_assert (left != NULL); + g_assert (top != NULL); + + /* Make sure the top of the window is on screen, for + * draggability (might not be necessary with all window managers, + * but seems reasonable anyway). Make sure the top of the window + * isn't off the bottom of the screen, or so close to the bottom + * that it might be obscured by the panel. + */ + *top = CLAMP (*top, 0, gdk_screen_height () - MINIMUM_ON_SCREEN_HEIGHT); + + /* FIXME bugzilla.eazel.com 669: + * If window has negative left coordinate, set_uposition sends it + * somewhere else entirely. Not sure what level contains this bug (XWindows?). + * Hacked around by pinning the left edge to zero, which just means you + * can't set a window to be partly off the left of the screen using + * this routine. + */ + /* Make sure the left edge of the window isn't off the right edge of + * the screen, or so close to the right edge that it might be + * obscured by the panel. + */ + *left = CLAMP (*left, 0, gdk_screen_width () - MINIMUM_ON_SCREEN_WIDTH); } static void -sanity_check_window_dimensions (guint *width, guint *height) +sanity_check_window_dimensions (guint *width, + guint *height) { - g_assert (width != NULL); - g_assert (height != NULL); - - /* Pin the size of the window to the screen, so we don't end up in - * a state where the window is so big essential parts of it can't - * be reached (might not be necessary with all window managers, - * but seems reasonable anyway). - */ - *width = MIN (*width, gdk_screen_width()); - *height = MIN (*height, gdk_screen_height()); + g_assert (width != NULL); + g_assert (height != NULL); + + /* Pin the size of the window to the screen, so we don't end up in + * a state where the window is so big essential parts of it can't + * be reached (might not be necessary with all window managers, + * but seems reasonable anyway). + */ + *width = MIN (*width, gdk_screen_width ()); + *height = MIN (*height, gdk_screen_height ()); } /** * eel_gtk_window_set_initial_geometry: - * + * * Sets the position and size of a GtkWindow before the * GtkWindow is shown. It is an error to call this on a window that * is already on-screen. Takes into account screen size, and does * some sanity-checking on the passed-in values. - * + * * @window: A non-visible GtkWindow * @geometry_flags: A EelGdkGeometryFlags value defining which of * the following parameters have defined values @@ -139,65 +140,69 @@ sanity_check_window_dimensions (guint *width, guint *height) * @height: height of window in pixels */ static void -eel_gtk_window_set_initial_geometry (GtkWindow *window, - EelGdkGeometryFlags geometry_flags, - int left, - int top, - guint width, - guint height) +eel_gtk_window_set_initial_geometry (GtkWindow *window, + EelGdkGeometryFlags geometry_flags, + int left, + int top, + guint width, + guint height) { - GdkScreen *screen; - int real_left, real_top; - int screen_width, screen_height; - - g_return_if_fail (GTK_IS_WINDOW (window)); - - /* Setting the default size doesn't work when the window is already showing. - * Someday we could make this move an already-showing window, but we don't - * need that functionality yet. - */ - g_return_if_fail (!gtk_widget_get_visible (GTK_WIDGET (window))); - - if ((geometry_flags & EEL_GDK_X_VALUE) && (geometry_flags & EEL_GDK_Y_VALUE)) { - real_left = left; - real_top = top; - - screen = gtk_window_get_screen (window); - screen_width = gdk_screen_get_width (screen); - screen_height = gdk_screen_get_height (screen); - - /* This is sub-optimal. GDK doesn't allow us to set win_gravity - * to South/East types, which should be done if using negative - * positions (so that the right or bottom edge of the window - * appears at the specified position, not the left or top). - * However it does seem to be consistent with other GNOME apps. - */ - if (geometry_flags & EEL_GDK_X_NEGATIVE) { - real_left = screen_width - real_left; - } - if (geometry_flags & EEL_GDK_Y_NEGATIVE) { - real_top = screen_height - real_top; - } - - sanity_check_window_position (&real_left, &real_top); - gtk_window_move (window, real_left, real_top); - } - - if ((geometry_flags & EEL_GDK_WIDTH_VALUE) && (geometry_flags & EEL_GDK_HEIGHT_VALUE)) { - sanity_check_window_dimensions (&width, &height); - gtk_window_set_default_size (GTK_WINDOW (window), (int)width, (int)height); - } + GdkScreen *screen; + int real_left, real_top; + int screen_width, screen_height; + + g_return_if_fail (GTK_IS_WINDOW (window)); + + /* Setting the default size doesn't work when the window is already showing. + * Someday we could make this move an already-showing window, but we don't + * need that functionality yet. + */ + g_return_if_fail (!gtk_widget_get_visible (GTK_WIDGET (window))); + + if ((geometry_flags & EEL_GDK_X_VALUE) && (geometry_flags & EEL_GDK_Y_VALUE)) + { + real_left = left; + real_top = top; + + screen = gtk_window_get_screen (window); + screen_width = gdk_screen_get_width (screen); + screen_height = gdk_screen_get_height (screen); + + /* This is sub-optimal. GDK doesn't allow us to set win_gravity + * to South/East types, which should be done if using negative + * positions (so that the right or bottom edge of the window + * appears at the specified position, not the left or top). + * However it does seem to be consistent with other GNOME apps. + */ + if (geometry_flags & EEL_GDK_X_NEGATIVE) + { + real_left = screen_width - real_left; + } + if (geometry_flags & EEL_GDK_Y_NEGATIVE) + { + real_top = screen_height - real_top; + } + + sanity_check_window_position (&real_left, &real_top); + gtk_window_move (window, real_left, real_top); + } + + if ((geometry_flags & EEL_GDK_WIDTH_VALUE) && (geometry_flags & EEL_GDK_HEIGHT_VALUE)) + { + sanity_check_window_dimensions (&width, &height); + gtk_window_set_default_size (GTK_WINDOW (window), (int) width, (int) height); + } } /** * eel_gtk_window_set_initial_geometry_from_string: - * + * * Sets the position and size of a GtkWindow before the - * GtkWindow is shown. The geometry is passed in as a string. + * GtkWindow is shown. The geometry is passed in as a string. * It is an error to call this on a window that * is already on-screen. Takes into account screen size, and does * some sanity-checking on the passed-in values. - * + * * @window: A non-visible GtkWindow * @geometry_string: A string suitable for use with eel_gdk_parse_geometry * @minimum_width: If the width from the string is smaller than this, @@ -207,55 +212,58 @@ eel_gtk_window_set_initial_geometry (GtkWindow *window, * @ignore_position: If true position data from string will be ignored. */ void -eel_gtk_window_set_initial_geometry_from_string (GtkWindow *window, - const char *geometry_string, - guint minimum_width, - guint minimum_height, - gboolean ignore_position) +eel_gtk_window_set_initial_geometry_from_string (GtkWindow *window, + const char *geometry_string, + guint minimum_width, + guint minimum_height, + gboolean ignore_position) { - int left, top; - guint width, height; - EelGdkGeometryFlags geometry_flags; - - g_return_if_fail (GTK_IS_WINDOW (window)); - g_return_if_fail (geometry_string != NULL); - - /* Setting the default size doesn't work when the window is already showing. - * Someday we could make this move an already-showing window, but we don't - * need that functionality yet. - */ - g_return_if_fail (!gtk_widget_get_visible (GTK_WIDGET (window))); - - geometry_flags = eel_gdk_parse_geometry (geometry_string, &left, &top, &width, &height); - - /* Make sure the window isn't smaller than makes sense for this window. - * Other sanity checks are performed in set_initial_geometry. - */ - if (geometry_flags & EEL_GDK_WIDTH_VALUE) { - width = MAX (width, minimum_width); - } - if (geometry_flags & EEL_GDK_HEIGHT_VALUE) { - height = MAX (height, minimum_height); - } - - /* Ignore saved window position if requested. */ - if (ignore_position) { - geometry_flags &= ~(EEL_GDK_X_VALUE | EEL_GDK_Y_VALUE); - } - - eel_gtk_window_set_initial_geometry (window, geometry_flags, left, top, width, height); + int left, top; + guint width, height; + EelGdkGeometryFlags geometry_flags; + + g_return_if_fail (GTK_IS_WINDOW (window)); + g_return_if_fail (geometry_string != NULL); + + /* Setting the default size doesn't work when the window is already showing. + * Someday we could make this move an already-showing window, but we don't + * need that functionality yet. + */ + g_return_if_fail (!gtk_widget_get_visible (GTK_WIDGET (window))); + + geometry_flags = eel_gdk_parse_geometry (geometry_string, &left, &top, &width, &height); + + /* Make sure the window isn't smaller than makes sense for this window. + * Other sanity checks are performed in set_initial_geometry. + */ + if (geometry_flags & EEL_GDK_WIDTH_VALUE) + { + width = MAX (width, minimum_width); + } + if (geometry_flags & EEL_GDK_HEIGHT_VALUE) + { + height = MAX (height, minimum_height); + } + + /* Ignore saved window position if requested. */ + if (ignore_position) + { + geometry_flags &= ~(EEL_GDK_X_VALUE | EEL_GDK_Y_VALUE); + } + + eel_gtk_window_set_initial_geometry (window, geometry_flags, left, top, width, height); } /** * eel_pop_up_context_menu: - * + * * Pop up a context menu under the mouse. - * The menu is sunk after use, so it will be destroyed unless the + * The menu is sunk after use, so it will be destroyed unless the * caller first ref'ed it. - * + * * This function is more of a helper function than a gtk extension, * so perhaps it belongs in a different file. - * + * * @menu: The menu to pop up under the mouse. * @offset_x: Ignored. * @offset_y: Ignored. @@ -263,76 +271,80 @@ eel_gtk_window_set_initial_geometry_from_string (GtkWindow *window, * is no event available. This is used to get the timestamp for the menu's popup. * In case no event is provided, gtk_get_current_event_time() will be used automatically. **/ -void -eel_pop_up_context_menu (GtkMenu *menu, - GdkEventButton *event) +void +eel_pop_up_context_menu (GtkMenu *menu, + GdkEventButton *event) { - int button; - - g_return_if_fail (GTK_IS_MENU (menu)); - - /* The event button needs to be 0 if we're popping up this menu from - * a button release, else a 2nd click outside the menu with any button - * other than the one that invoked the menu will be ignored (instead - * of dismissing the menu). This is a subtle fragility of the GTK menu code. - */ - - if (event) { - button = event->type == GDK_BUTTON_RELEASE - ? 0 - : event->button; - } else { - button = 0; - } - - gtk_menu_popup (menu, /* menu */ - NULL, /* parent_menu_shell */ - NULL, /* parent_menu_item */ - NULL, /* popup_position_func */ - NULL, /* popup_position_data */ - button, /* button */ - event ? event->time : gtk_get_current_event_time ()); /* activate_time */ - - g_object_ref_sink (menu); - g_object_unref (menu); + int button; + + g_return_if_fail (GTK_IS_MENU (menu)); + + /* The event button needs to be 0 if we're popping up this menu from + * a button release, else a 2nd click outside the menu with any button + * other than the one that invoked the menu will be ignored (instead + * of dismissing the menu). This is a subtle fragility of the GTK menu code. + */ + + if (event) + { + button = event->type == GDK_BUTTON_RELEASE + ? 0 + : event->button; + } + else + { + button = 0; + } + + gtk_menu_popup (menu, /* menu */ + NULL, /* parent_menu_shell */ + NULL, /* parent_menu_item */ + NULL, /* popup_position_func */ + NULL, /* popup_position_data */ + button, /* button */ + event ? event->time : gtk_get_current_event_time ()); /* activate_time */ + + g_object_ref_sink (menu); + g_object_unref (menu); } GtkMenuItem * eel_gtk_menu_append_separator (GtkMenu *menu) { - return eel_gtk_menu_insert_separator (menu, -1); + return eel_gtk_menu_insert_separator (menu, -1); } GtkMenuItem * -eel_gtk_menu_insert_separator (GtkMenu *menu, int index) +eel_gtk_menu_insert_separator (GtkMenu *menu, + int index) { - GtkWidget *menu_item; + GtkWidget *menu_item; - menu_item = gtk_separator_menu_item_new (); - gtk_widget_show (menu_item); - gtk_menu_shell_insert (GTK_MENU_SHELL (menu), menu_item, index); + menu_item = gtk_separator_menu_item_new (); + gtk_widget_show (menu_item); + gtk_menu_shell_insert (GTK_MENU_SHELL (menu), menu_item, index); - return GTK_MENU_ITEM (menu_item); + return GTK_MENU_ITEM (menu_item); } void eel_gtk_message_dialog_set_details_label (GtkMessageDialog *dialog, - const gchar *details_text) + const gchar *details_text) { - GtkWidget *content_area, *expander, *label; + GtkWidget *content_area, *expander, *label; - content_area = gtk_message_dialog_get_message_area (dialog); - expander = gtk_expander_new_with_mnemonic (_("Show more _details")); - gtk_expander_set_spacing (GTK_EXPANDER (expander), 6); + content_area = gtk_message_dialog_get_message_area (dialog); + expander = gtk_expander_new_with_mnemonic (_("Show more _details")); + gtk_expander_set_spacing (GTK_EXPANDER (expander), 6); - label = gtk_label_new (details_text); - gtk_label_set_line_wrap (GTK_LABEL (label), TRUE); - gtk_label_set_selectable (GTK_LABEL (label), TRUE); - gtk_label_set_xalign (GTK_LABEL (label), 0); + label = gtk_label_new (details_text); + gtk_label_set_line_wrap (GTK_LABEL (label), TRUE); + gtk_label_set_selectable (GTK_LABEL (label), TRUE); + gtk_label_set_xalign (GTK_LABEL (label), 0); - gtk_container_add (GTK_CONTAINER (expander), label); - gtk_box_pack_start (GTK_BOX (content_area), expander, FALSE, FALSE, 0); + gtk_container_add (GTK_CONTAINER (expander), label); + gtk_box_pack_start (GTK_BOX (content_area), expander, FALSE, FALSE, 0); - gtk_widget_show (label); - gtk_widget_show (expander); + gtk_widget_show (label); + gtk_widget_show (expander); } |