gtk2/gtk/gtkwindowgroup.c

263 lines
6.9 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"
#include "gtkprivate.h"
/**
2021-03-02 03:48:08 +00:00
* GtkWindowGroup:
*
2021-03-02 03:48:08 +00:00
* `GtkWindowGroup` makes group of windows behave like separate applications.
*
* It achieves this by limiting the effect of GTK grabs and modality
* to windows in the same group.
2014-06-05 01:25:05 +00:00
*
* 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.
*
2021-03-02 03:48:08 +00:00
* `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;
};
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:
2021-03-02 03:48:08 +00:00
*
* Creates a new `GtkWindowGroup` object.
*
* Modality of windows only affects windows
2021-03-02 03:48:08 +00:00
* within the same `GtkWindowGroup`.
*
2021-03-02 03:48:08 +00:00
* 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;
GSList *tmp_list;
GSList *to_remove = NULL;
priv = group->priv;
tmp_list = priv->grabs;
while (tmp_list)
{
if (gtk_widget_get_root (tmp_list->data) == (GtkRoot*) 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);
}
}
/**
* gtk_window_group_add_window:
2021-03-02 03:48:08 +00:00
* @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:
2021-03-02 03:48:08 +00:00
* @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:
2021-03-02 03:48:08 +00:00
* @window_group: a `GtkWindowGroup`
*
2021-03-02 03:48:08 +00:00
* 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.
2021-03-02 03:48:08 +00:00
*/
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_group (window))
group_windows = g_list_prepend (group_windows, window);
}
g_list_free (toplevels);
return g_list_reverse (group_windows);
}
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);
}