gtk2/gtk/gtkwindowgroup.c

422 lines
11 KiB
C
Raw Normal View History

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#include "config.h"
#include "gtkmain.h"
#include "gtkwindowprivate.h"
#include "gtkwindowgroup.h"
/**
* SECTION:gtkwindowgroup
* @Short_description: Limit the effect of grabs
* @Title: GtkWindowGroup
*
2014-06-05 01:25:05 +00:00
* A #GtkWindowGroup restricts the effect of grabs to windows
* in the same group, thereby making window groups almost behave
* like separate applications.
*
* A window can be a member in at most one window group at a time.
* Windows that have not been explicitly assigned to a group are
* implicitly treated like windows of the default window group.
*
* GtkWindowGroup objects are referenced by each window in the group,
* so once you have added all windows to a GtkWindowGroup, you can drop
* the initial reference to the window group with g_object_unref(). If the
* windows in the window group are subsequently destroyed, then they will
* be removed from the window group and drop their references on the window
* group; when all window have been removed, the window group will be
* freed.
*/
typedef struct _GtkDeviceGrabInfo GtkDeviceGrabInfo;
struct _GtkDeviceGrabInfo
{
GtkWidget *widget;
GdkDevice *device;
guint block_others : 1;
};
struct _GtkWindowGroupPrivate
{
GSList *grabs;
GSList *device_grabs;
};
G_DEFINE_TYPE_WITH_PRIVATE (GtkWindowGroup, gtk_window_group, G_TYPE_OBJECT)
static void
gtk_window_group_init (GtkWindowGroup *group)
{
group->priv = gtk_window_group_get_instance_private (group);
}
static void
gtk_window_group_class_init (GtkWindowGroupClass *klass)
{
}
/**
* gtk_window_group_new:
*
* Creates a new #GtkWindowGroup object. Grabs added with
* gtk_grab_add() only affect windows within the same #GtkWindowGroup.
*
* Returns: a new #GtkWindowGroup.
**/
GtkWindowGroup *
gtk_window_group_new (void)
{
return g_object_new (GTK_TYPE_WINDOW_GROUP, NULL);
}
static void
window_group_cleanup_grabs (GtkWindowGroup *group,
GtkWindow *window)
{
GtkWindowGroupPrivate *priv;
GtkDeviceGrabInfo *info;
GSList *tmp_list;
GSList *to_remove = NULL;
priv = group->priv;
tmp_list = priv->grabs;
while (tmp_list)
{
if (gtk_widget_get_toplevel (tmp_list->data) == (GtkWidget*) window)
to_remove = g_slist_prepend (to_remove, g_object_ref (tmp_list->data));
tmp_list = tmp_list->next;
}
while (to_remove)
{
gtk_grab_remove (to_remove->data);
g_object_unref (to_remove->data);
to_remove = g_slist_delete_link (to_remove, to_remove);
}
tmp_list = priv->device_grabs;
while (tmp_list)
{
info = tmp_list->data;
if (gtk_widget_get_toplevel (info->widget) == (GtkWidget *) window)
to_remove = g_slist_prepend (to_remove, info);
tmp_list = tmp_list->next;
}
while (to_remove)
{
info = to_remove->data;
gtk_device_grab_remove (info->widget, info->device);
to_remove = g_slist_delete_link (to_remove, to_remove);
}
}
/**
* gtk_window_group_add_window:
* @window_group: a #GtkWindowGroup
* @window: the #GtkWindow to add
*
* Adds a window to a #GtkWindowGroup.
**/
void
gtk_window_group_add_window (GtkWindowGroup *window_group,
GtkWindow *window)
{
GtkWindowGroup *old_group;
g_return_if_fail (GTK_IS_WINDOW_GROUP (window_group));
g_return_if_fail (GTK_IS_WINDOW (window));
old_group = _gtk_window_get_window_group (window);
if (old_group != window_group)
{
g_object_ref (window);
g_object_ref (window_group);
if (old_group)
gtk_window_group_remove_window (old_group, window);
else
window_group_cleanup_grabs (gtk_window_get_group (NULL), window);
_gtk_window_set_window_group (window, window_group);
g_object_unref (window);
}
}
/**
* gtk_window_group_remove_window:
* @window_group: a #GtkWindowGroup
* @window: the #GtkWindow to remove
*
* Removes a window from a #GtkWindowGroup.
**/
void
gtk_window_group_remove_window (GtkWindowGroup *window_group,
GtkWindow *window)
{
g_return_if_fail (GTK_IS_WINDOW_GROUP (window_group));
g_return_if_fail (GTK_IS_WINDOW (window));
g_return_if_fail (_gtk_window_get_window_group (window) == window_group);
g_object_ref (window);
window_group_cleanup_grabs (window_group, window);
_gtk_window_set_window_group (window, NULL);
g_object_unref (window_group);
g_object_unref (window);
}
/**
* gtk_window_group_list_windows:
* @window_group: a #GtkWindowGroup
*
* Returns a list of the #GtkWindows that belong to @window_group.
*
* Returns: (element-type GtkWindow) (transfer container): A
* newly-allocated list of windows inside the group.
**/
GList *
gtk_window_group_list_windows (GtkWindowGroup *window_group)
{
GList *toplevels, *toplevel, *group_windows;
g_return_val_if_fail (GTK_IS_WINDOW_GROUP (window_group), NULL);
group_windows = NULL;
toplevels = gtk_window_list_toplevels ();
for (toplevel = toplevels; toplevel; toplevel = toplevel->next)
{
GtkWindow *window = toplevel->data;
if (window_group == _gtk_window_get_window_group (window))
group_windows = g_list_prepend (group_windows, window);
}
g_list_free (toplevels);
return g_list_reverse (group_windows);
}
/**
* gtk_window_group_get_current_grab:
* @window_group: a #GtkWindowGroup
*
* Gets the current grab widget of the given group,
* see gtk_grab_add().
*
* Returns: (transfer none): the current grab widget of the group
*/
GtkWidget *
gtk_window_group_get_current_grab (GtkWindowGroup *window_group)
{
g_return_val_if_fail (GTK_IS_WINDOW_GROUP (window_group), NULL);
if (window_group->priv->grabs)
return GTK_WIDGET (window_group->priv->grabs->data);
return NULL;
}
static void
revoke_implicit_grabs (GtkWindowGroup *window_group,
GdkDevice *device,
GtkWidget *grab_widget)
{
GList *windows, *l;
windows = gtk_window_group_list_windows (window_group);
for (l = windows; l; l = l->next)
{
gtk_window_maybe_revoke_implicit_grab (l->data,
device,
grab_widget);
}
g_list_free (windows);
}
void
_gtk_window_group_add_grab (GtkWindowGroup *window_group,
GtkWidget *widget)
{
GtkWindowGroupPrivate *priv;
priv = window_group->priv;
priv->grabs = g_slist_prepend (priv->grabs, widget);
revoke_implicit_grabs (window_group, NULL, widget);
}
void
_gtk_window_group_remove_grab (GtkWindowGroup *window_group,
GtkWidget *widget)
{
GtkWindowGroupPrivate *priv;
priv = window_group->priv;
priv->grabs = g_slist_remove (priv->grabs, widget);
}
void
_gtk_window_group_add_device_grab (GtkWindowGroup *window_group,
GtkWidget *widget,
GdkDevice *device,
gboolean block_others)
{
GtkWindowGroupPrivate *priv;
GtkDeviceGrabInfo *info;
priv = window_group->priv;
info = g_slice_new0 (GtkDeviceGrabInfo);
info->widget = widget;
info->device = device;
info->block_others = block_others;
priv->device_grabs = g_slist_prepend (priv->device_grabs, info);
revoke_implicit_grabs (window_group, device, widget);
}
void
_gtk_window_group_remove_device_grab (GtkWindowGroup *window_group,
GtkWidget *widget,
GdkDevice *device)
{
GtkWindowGroupPrivate *priv;
GtkDeviceGrabInfo *info;
GSList *list, *node = NULL;
GdkDevice *other_device;
priv = window_group->priv;
other_device = gdk_device_get_associated_device (device);
list = priv->device_grabs;
while (list)
{
info = list->data;
if (info->widget == widget &&
(info->device == device ||
info->device == other_device))
{
node = list;
break;
}
list = list->next;
}
if (node)
{
info = node->data;
priv->device_grabs = g_slist_delete_link (priv->device_grabs, node);
g_slice_free (GtkDeviceGrabInfo, info);
}
}
/**
* gtk_window_group_get_current_device_grab:
* @window_group: a #GtkWindowGroup
* @device: a #GdkDevice
*
* Returns the current grab widget for @device, or %NULL if none.
*
introspection: This patch fixes nullable return values fixes for the following symbols in gtk gtk_accel_group_query gtk_accel_group_from_accel_closure gtk_accel_label_get_accel_widget gtk_accessible_get_widget gtk_actionable_get_action_name gtk_app_chooser_get_app_info gtk_app_chooser_button_get_heading gtk_app_chooser_dialog_get_heading gtk_application_get_window_by_id gtk_assistant_get_nth_page gtk_binding_set_find gtk_builder_get_object gtk_builder_lookup_callback_symbol gtk_builder_get_application gtk_button_get_image gtk_cell_area_get_focus_from_sibling gtk_cell_renderer_start_editing gtk_cell_view_get_model gtk_cell_view_get_displayed_row gtk_clipboard_get_owner gtk_container_get_focus_child gtk_container_get_focus_vadjustment gtk_container_get_focus_hadjustment gtk_dialog_get_widget_for_response gtk_drag_get_source_widget gtk_drag_dest_get_target_list gtk_drag_source_get_target_list gtk_entry_completion_get_model gtk_entry_completion_compute_prefix gtk_expander_get_label_widget gtk_file_chooser_get_filename gtk_file_chooser_get_current_folder gtk_file_chooser_get_uri gtk_file_chooser_get_current_folder_uri gtk_file_chooser_get_preview_widget gtk_file_chooser_get_preview_file gtk_file_chooser_get_preview_filename gtk_file_chooser_get_preview_uri gtk_file_chooser_get_extra_widget gtk_file_chooser_get_filter gtk_file_chooser_native_get_accept_label gtk_file_chooser_native_get_cancel_label gtk_file_filter_get_name gtk_font_chooser_get_font_family gtk_font_chooser_get_font_face gtk_font_chooser_get_font gtk_font_chooser_get_font_desc gtk_font_chooser_get_font_map gtk_frame_get_label gtk_gesture_get_device gtk_gesture_get_window gtk_gl_area_get_error gtk_header_bar_get_title gtk_header_bar_get_subtitle gtk_header_bar_get_custom_title gtk_icon_info_get_filename gtk_icon_view_get_path_at_pos gtk_icon_view_get_model gtk_image_get_pixbuf gtk_image_get_animation gtk_label_get_mnemonic_widget gtk_label_get_attributes gtk_check_version gtk_menu_button_get_popup gtk_menu_button_get_menu_model gtk_menu_button_get_align_widget gtk_menu_button_get_popover gtk_menu_item_get_submenu gtk_menu_item_get_accel_path gtk_native_dialog_get_title gtk_native_dialog_get_transient_for gtk_notebook_get_nth_page gtk_notebook_get_tab_label_text gtk_notebook_get_menu_label gtk_notebook_get_menu_label_text gtk_notebook_get_group_name gtk_notebook_get_action_widget gtk_offscreen_window_get_surface gtk_offscreen_window_get_pixbuf gtk_paned_get_child1 gtk_paned_get_child2 gtk_places_sidebar_get_location gtk_places_sidebar_get_nth_bookmark gtk_plug_get_socket_window gtk_popover_get_default_widget gtk_progress_bar_get_text gtk_recent_filter_get_name gtk_recent_manager_lookup_item gtk_settings_get_default gtk_socket_get_plug_window gtk_stack_sidebar_get_stack gtk_stack_switcher_get_stack gtk_style_context_get_section gtk_style_context_get_parent gtk_style_context_get_frame_clock gtk_test_find_widget gtk_text_buffer_get_mark gtk_text_tag_table_lookup gtk_text_view_get_tabs gtk_text_view_toggle_cursor_visible gtk_text_view_get_window gtk_toolbar_get_nth_item gtk_tool_button_get_label gtk_tool_button_get_icon_name gtk_tool_button_get_label_widget gtk_tool_button_get_icon_widget gtk_tool_palette_get_drop_item gtk_tool_palette_get_drop_group gtk_tree_model_filter_convert_child_path_to_path gtk_tree_model_filter_convert_path_to_child_path gtk_tree_model_sort_convert_child_path_to_path gtk_tree_model_sort_convert_path_to_child_path gtk_tree_view_get_column gtk_tree_view_get_bin_window gtk_tree_view_column_get_widget gtk_tree_view_column_get_tree_view gtk_widget_get_frame_clock gtk_window_group_get_current_device_grab GtkTextBufferSerializeFunc
2015-12-28 20:14:08 +00:00
* Returns: (nullable) (transfer none): The grab widget, or %NULL
*/
GtkWidget *
gtk_window_group_get_current_device_grab (GtkWindowGroup *window_group,
GdkDevice *device)
{
GtkWindowGroupPrivate *priv;
GtkDeviceGrabInfo *info;
GdkDevice *other_device;
GSList *list;
g_return_val_if_fail (GTK_IS_WINDOW_GROUP (window_group), NULL);
g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
priv = window_group->priv;
list = priv->device_grabs;
other_device = gdk_device_get_associated_device (device);
while (list)
{
info = list->data;
list = list->next;
if (info->device == device ||
info->device == other_device)
return info->widget;
}
return NULL;
}
gboolean
_gtk_window_group_widget_is_blocked_for_device (GtkWindowGroup *window_group,
GtkWidget *widget,
GdkDevice *device)
{
GtkWindowGroupPrivate *priv;
GtkDeviceGrabInfo *info;
GdkDevice *other_device;
GSList *list;
priv = window_group->priv;
other_device = gdk_device_get_associated_device (device);
list = priv->device_grabs;
while (list)
{
info = list->data;
list = list->next;
/* Look for blocking grabs on other device pairs
* that have the passed widget within the GTK+ grab.
*/
if (info->block_others &&
info->device != device &&
info->device != other_device &&
(info->widget == widget ||
gtk_widget_is_ancestor (widget, info->widget)))
return TRUE;
}
return FALSE;
}