forked from AuroraMiddleware/gtk
a546ae32d7
Those property features don't seem to be in use anywhere. They are redundant since the docs cover the same information and more. They also created unnecessary translation work. Closes #4904
321 lines
9.4 KiB
C
321 lines
9.4 KiB
C
/* GTK - The GIMP Toolkit
|
|
* Copyright (C) 2020, 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(s): Matthias Clasen <mclasen@redhat.com>
|
|
*/
|
|
|
|
/**
|
|
* GtkEventControllerFocus:
|
|
*
|
|
* `GtkEventControllerFocus` is an event controller to keep track of
|
|
* keyboard focus.
|
|
*
|
|
* The event controller offers [signal@Gtk.EventControllerFocus::enter]
|
|
* and [signal@Gtk.EventControllerFocus::leave] signals, as well as
|
|
* [property@Gtk.EventControllerFocus:is-focus] and
|
|
* [property@Gtk.EventControllerFocus:contains-focus] properties
|
|
* which are updated to reflect focus changes inside the widget hierarchy
|
|
* that is rooted at the controllers widget.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include "gtkintl.h"
|
|
#include "gtkmarshalers.h"
|
|
#include "gtkprivate.h"
|
|
#include "gtkwidgetprivate.h"
|
|
#include "gtkeventcontrollerprivate.h"
|
|
#include "gtkeventcontrollerfocus.h"
|
|
#include "gtkenums.h"
|
|
#include "gtkmain.h"
|
|
#include "gtktypebuiltins.h"
|
|
|
|
#include <gdk/gdk.h>
|
|
|
|
struct _GtkEventControllerFocus
|
|
{
|
|
GtkEventController parent_instance;
|
|
|
|
guint is_focus : 1;
|
|
guint contains_focus : 1;
|
|
};
|
|
|
|
struct _GtkEventControllerFocusClass
|
|
{
|
|
GtkEventControllerClass parent_class;
|
|
};
|
|
|
|
enum {
|
|
ENTER,
|
|
LEAVE,
|
|
N_SIGNALS
|
|
};
|
|
|
|
static guint signals[N_SIGNALS] = { 0 };
|
|
|
|
enum {
|
|
PROP_IS_FOCUS = 1,
|
|
PROP_CONTAINS_FOCUS,
|
|
NUM_PROPERTIES
|
|
};
|
|
|
|
static GParamSpec *props[NUM_PROPERTIES] = { NULL, };
|
|
|
|
G_DEFINE_TYPE (GtkEventControllerFocus, gtk_event_controller_focus,
|
|
GTK_TYPE_EVENT_CONTROLLER)
|
|
|
|
static void
|
|
gtk_event_controller_focus_finalize (GObject *object)
|
|
{
|
|
//GtkEventControllerFocus *focus = GTK_EVENT_CONTROLLER_FOCUS (object);
|
|
|
|
G_OBJECT_CLASS (gtk_event_controller_focus_parent_class)->finalize (object);
|
|
}
|
|
|
|
static void
|
|
update_focus (GtkEventController *controller,
|
|
const GtkCrossingData *crossing)
|
|
{
|
|
GtkEventControllerFocus *focus = GTK_EVENT_CONTROLLER_FOCUS (controller);
|
|
GtkWidget *widget = gtk_event_controller_get_widget (controller);
|
|
gboolean is_focus = FALSE;
|
|
gboolean contains_focus = FALSE;
|
|
gboolean enter = FALSE;
|
|
gboolean leave = FALSE;
|
|
|
|
if (crossing->direction == GTK_CROSSING_IN)
|
|
{
|
|
if (crossing->new_descendent != NULL)
|
|
{
|
|
contains_focus = TRUE;
|
|
}
|
|
if (crossing->new_target == widget)
|
|
{
|
|
contains_focus = TRUE;
|
|
is_focus = TRUE;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (crossing->new_descendent != NULL ||
|
|
crossing->new_target == widget)
|
|
contains_focus = TRUE;
|
|
is_focus = FALSE;
|
|
}
|
|
|
|
if (focus->contains_focus != contains_focus)
|
|
{
|
|
enter = contains_focus;
|
|
leave = !contains_focus;
|
|
}
|
|
|
|
if (leave)
|
|
g_signal_emit (controller, signals[LEAVE], 0);
|
|
|
|
g_object_freeze_notify (G_OBJECT (focus));
|
|
if (focus->is_focus != is_focus)
|
|
{
|
|
focus->is_focus = is_focus;
|
|
g_object_notify (G_OBJECT (focus), "is-focus");
|
|
}
|
|
|
|
if (focus->contains_focus != contains_focus)
|
|
{
|
|
focus->contains_focus = contains_focus;
|
|
g_object_notify (G_OBJECT (focus), "contains-focus");
|
|
}
|
|
g_object_thaw_notify (G_OBJECT (focus));
|
|
|
|
if (enter)
|
|
g_signal_emit (controller, signals[ENTER], 0);
|
|
}
|
|
|
|
static void
|
|
gtk_event_controller_focus_handle_crossing (GtkEventController *controller,
|
|
const GtkCrossingData *crossing,
|
|
double x,
|
|
double y)
|
|
{
|
|
if (crossing->type == GTK_CROSSING_FOCUS ||
|
|
crossing->type == GTK_CROSSING_ACTIVE)
|
|
update_focus (controller, crossing);
|
|
}
|
|
|
|
static void
|
|
gtk_event_controller_focus_get_property (GObject *object,
|
|
guint prop_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
GtkEventControllerFocus *controller = GTK_EVENT_CONTROLLER_FOCUS (object);
|
|
|
|
switch (prop_id)
|
|
{
|
|
case PROP_IS_FOCUS:
|
|
g_value_set_boolean (value, controller->is_focus);
|
|
break;
|
|
|
|
case PROP_CONTAINS_FOCUS:
|
|
g_value_set_boolean (value, controller->contains_focus);
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
}
|
|
}
|
|
|
|
static void
|
|
gtk_event_controller_focus_class_init (GtkEventControllerFocusClass *klass)
|
|
{
|
|
GtkEventControllerClass *controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);
|
|
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
|
|
|
object_class->finalize = gtk_event_controller_focus_finalize;
|
|
object_class->get_property = gtk_event_controller_focus_get_property;
|
|
controller_class->handle_crossing = gtk_event_controller_focus_handle_crossing;
|
|
|
|
/**
|
|
* GtkEventControllerFocus:is-focus: (attributes org.gtk.Property.get=gtk_event_controller_focus_is_focus)
|
|
*
|
|
* %TRUE if focus is in the controllers widget itself,
|
|
* as opposed to in a descendent widget.
|
|
*
|
|
* See also [property@Gtk.EventControllerFocus:contains-focus].
|
|
*
|
|
* When handling focus events, this property is updated
|
|
* before [signal@Gtk.EventControllerFocus::enter] or
|
|
* [signal@Gtk.EventControllerFocus::leave] are emitted.
|
|
*/
|
|
props[PROP_IS_FOCUS] =
|
|
g_param_spec_boolean ("is-focus", NULL, NULL,
|
|
FALSE,
|
|
G_PARAM_READABLE);
|
|
|
|
/**
|
|
* GtkEventControllerFocus:contains-focus: (attributes org.gtk.Property.get=gtk_event_controller_focus_contains_focus)
|
|
*
|
|
* %TRUE if focus is contained in the controllers widget.
|
|
*
|
|
* See [property@Gtk.EventControllerFocus:is-focus] for whether
|
|
* the focus is in the widget itself or inside a descendent.
|
|
*
|
|
* When handling focus events, this property is updated
|
|
* before [signal@Gtk.EventControllerFocus::enter] or
|
|
* [signal@Gtk.EventControllerFocus::leave] are emitted.
|
|
*/
|
|
props[PROP_CONTAINS_FOCUS] =
|
|
g_param_spec_boolean ("contains-focus", NULL, NULL,
|
|
FALSE,
|
|
G_PARAM_READABLE);
|
|
|
|
g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
|
|
|
|
/**
|
|
* GtkEventControllerFocus::enter:
|
|
* @controller: the object which received the signal
|
|
*
|
|
* Emitted whenever the focus enters into the widget or one
|
|
* of its descendents.
|
|
*
|
|
* Note that this means you may not get an ::enter signal
|
|
* even though the widget becomes the focus location, in
|
|
* certain cases (such as when the focus moves from a descendent
|
|
* of the widget to the widget itself). If you are interested
|
|
* in these cases, you can monitor the
|
|
* [property@Gtk.EventControllerFocus:is-focus]
|
|
* property for changes.
|
|
*/
|
|
signals[ENTER] =
|
|
g_signal_new (I_("enter"),
|
|
GTK_TYPE_EVENT_CONTROLLER_FOCUS,
|
|
G_SIGNAL_RUN_LAST,
|
|
0, NULL, NULL,
|
|
NULL,
|
|
G_TYPE_NONE, 0);
|
|
|
|
/**
|
|
* GtkEventControllerFocus::leave:
|
|
* @controller: the object which received the signal
|
|
*
|
|
* Emitted whenever the focus leaves the widget hierarchy
|
|
* that is rooted at the widget that the controller is attached to.
|
|
*
|
|
* Note that this means you may not get a ::leave signal
|
|
* even though the focus moves away from the widget, in
|
|
* certain cases (such as when the focus moves from the widget
|
|
* to a descendent). If you are interested in these cases, you
|
|
* can monitor the [property@Gtk.EventControllerFocus:is-focus]
|
|
* property for changes.
|
|
*/
|
|
signals[LEAVE] =
|
|
g_signal_new (I_("leave"),
|
|
GTK_TYPE_EVENT_CONTROLLER_FOCUS,
|
|
G_SIGNAL_RUN_LAST,
|
|
0, NULL, NULL,
|
|
NULL,
|
|
G_TYPE_NONE, 0);
|
|
}
|
|
|
|
static void
|
|
gtk_event_controller_focus_init (GtkEventControllerFocus *controller)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* gtk_event_controller_focus_new:
|
|
*
|
|
* Creates a new event controller that will handle focus events.
|
|
*
|
|
* Returns: a new `GtkEventControllerFocus`
|
|
**/
|
|
GtkEventController *
|
|
gtk_event_controller_focus_new (void)
|
|
{
|
|
return g_object_new (GTK_TYPE_EVENT_CONTROLLER_FOCUS, NULL);
|
|
}
|
|
|
|
/**
|
|
* gtk_event_controller_focus_contains_focus: (attributes org.gtk.Method.get_property=contains-focus)
|
|
* @self: a `GtkEventControllerFocus`
|
|
*
|
|
* Returns %TRUE if focus is within @self or one of its children.
|
|
*
|
|
* Returns: %TRUE if focus is within @self or one of its children
|
|
*/
|
|
gboolean
|
|
gtk_event_controller_focus_contains_focus (GtkEventControllerFocus *self)
|
|
{
|
|
g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER_FOCUS (self), FALSE);
|
|
|
|
return self->contains_focus;
|
|
}
|
|
|
|
/**
|
|
* gtk_event_controller_focus_is_focus: (attributes org.gtk.Method.get_property=is-focus)
|
|
* @self: a `GtkEventControllerFocus`
|
|
*
|
|
* Returns %TRUE if focus is within @self, but not one of its children.
|
|
*
|
|
* Returns: %TRUE if focus is within @self, but not one of its children
|
|
*/
|
|
gboolean
|
|
gtk_event_controller_focus_is_focus (GtkEventControllerFocus *self)
|
|
{
|
|
g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER_FOCUS (self), FALSE);
|
|
|
|
return self->is_focus;
|
|
}
|