mutter/clutter/clutter/clutter-grab.c
Carlos Garnacho 9c5bd9f847 clutter: Add "revoked" property to ClutterGrab
Users of Clutter grabs may listen for notify::revoked changes in
order to know that their grab is no longer in charge of event
propagation, without the use of crossing events.

Since a ClutterGrab may stay in the stack and regain effects,
this notification also happens the other way around.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3420>
2024-02-13 12:36:26 +01:00

130 lines
3.1 KiB
C

/*
* Clutter.
*
* Copyright (C) 2023 Red Hat Inc.
*
* 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/>.
*
* Author: Carlos Garnacho <carlosg@gnome.org>
*/
#include "config.h"
#include "clutter-grab-private.h"
#include "clutter-private.h"
enum
{
PROP_0,
PROP_REVOKED,
N_PROPS,
};
static GParamSpec *props[N_PROPS] = { 0, };
G_DEFINE_FINAL_TYPE (ClutterGrab, clutter_grab, G_TYPE_OBJECT)
static void
clutter_grab_dispose (GObject *object)
{
clutter_grab_dismiss (CLUTTER_GRAB (object));
G_OBJECT_CLASS (clutter_grab_parent_class)->dispose (object);
}
static void
clutter_grab_finalize (GObject *object)
{
ClutterGrab *grab = CLUTTER_GRAB (object);
if (grab->owns_actor)
g_clear_pointer (&grab->actor, clutter_actor_destroy);
G_OBJECT_CLASS (clutter_grab_parent_class)->finalize (object);
}
static void
clutter_grab_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
ClutterGrab *grab = CLUTTER_GRAB (object);
switch (prop_id)
{
case PROP_REVOKED:
g_value_set_boolean (value, clutter_grab_is_revoked (grab));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
clutter_grab_class_init (ClutterGrabClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = clutter_grab_dispose;
object_class->finalize = clutter_grab_finalize;
object_class->get_property = clutter_grab_get_property;
props[PROP_REVOKED] =
g_param_spec_boolean ("revoked", NULL, NULL,
FALSE,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS |
G_PARAM_EXPLICIT_NOTIFY);
g_object_class_install_properties (object_class, N_PROPS, props);
}
static void
clutter_grab_init (ClutterGrab *grab)
{
}
ClutterGrab *
clutter_grab_new (ClutterStage *stage,
ClutterActor *actor,
gboolean owns_actor)
{
ClutterGrab *grab;
grab = g_object_new (CLUTTER_TYPE_GRAB, NULL);
grab->stage = stage;
grab->actor = actor;
if (owns_actor)
grab->owns_actor = TRUE;
return grab;
}
void
clutter_grab_notify (ClutterGrab *grab)
{
g_object_notify (G_OBJECT (grab), "revoked");
}
gboolean
clutter_grab_is_revoked (ClutterGrab *grab)
{
g_return_val_if_fail (CLUTTER_IS_GRAB (grab), FALSE);
return grab->prev != NULL;
}