gtkmm: Gtk::EventControllerFocus Class Reference

Event controller for focus. More...

#include <gtkmm/eventcontrollerfocus.h>

Inheritance diagram for Gtk::EventControllerFocus:

[legend]

Public Member Functions
	EventControllerFocus (EventControllerFocus &&src) noexcept

EventControllerFocus &	operator= (EventControllerFocus &&src) noexcept

	~EventControllerFocus () noexcept override

GtkEventControllerFocus *	gobj ()
	Provides access to the underlying C GObject.

const GtkEventControllerFocus *	gobj () const
	Provides access to the underlying C GObject.

GtkEventControllerFocus *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool	contains_focus () const
	Returns `true` if focus is within self or one of its children.

bool	is_focus () const
	Returns `true` if focus is within self, but not one of its children.

Glib::SignalProxy< void()>	signal_enter ()

Glib::SignalProxy< void()>	signal_leave ()

Glib::PropertyProxy_ReadOnly< bool >	property_is_focus () const
	`true` if focus is in the controllers widget itself, as opposed to in a descendent widget.

Glib::PropertyProxy_ReadOnly< bool >	property_contains_focus () const
	`true` if focus is contained in the controllers widget.

Public Member Functions inherited from Gtk::EventController
	EventController (EventController &&src) noexcept

EventController &	operator= (EventController &&src) noexcept

	~EventController () noexcept override

GtkEventController *	gobj ()
	Provides access to the underlying C GObject.

const GtkEventController *	gobj () const
	Provides access to the underlying C GObject.

GtkEventController *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Widget *	get_widget ()
	Returns the `Gtk::Widget` this controller relates to.

const Widget *	get_widget () const
	Returns the `Gtk::Widget` this controller relates to.

void	reset ()
	Resets the controller to a clean state.

PropagationPhase	get_propagation_phase () const
	Gets the propagation phase at which controller handles events.

void	set_propagation_phase (PropagationPhase phase)
	Sets the propagation phase at which a controller handles events.

PropagationLimit	get_propagation_limit () const
	Gets the propagation limit of the event controller.

void	set_propagation_limit (PropagationLimit limit)
	Sets the event propagation limit on the event controller.

Glib::ustring	get_name () const
	Gets the name of controller.

void	set_name (const Glib::ustring & name)
	Sets a name on the controller that can be used for debugging.

Glib::RefPtr< const Gdk::Event >	get_current_event () const
	Returns the event that is currently being handled by the controller.

guint32	get_current_event_time () const
	Returns the timestamp of the event that is currently being handled by the controller.

Glib::RefPtr< Gdk::Device >	get_current_event_device ()
	Returns the device of the event that is currently being handled by the controller.

Glib::RefPtr< const Gdk::Device >	get_current_event_device () const
	Returns the event that is currently being handled by the controller.

Gdk::ModifierType	get_current_event_state () const
	Returns the modifier state of the event that is currently being handled by the controller.

Glib::PropertyProxy_ReadOnly< Widget * >	property_widget () const
	The widget receiving the `Gdk::Events` that the controller will handle.

Glib::PropertyProxy< PropagationPhase >	property_propagation_phase ()
	The propagation phase at which this controller will handle events.

Glib::PropertyProxy_ReadOnly< PropagationPhase >	property_propagation_phase () const
	The propagation phase at which this controller will handle events.

Glib::PropertyProxy< PropagationLimit >	property_propagation_limit ()
	The limit for which events this controller will handle.

Glib::PropertyProxy_ReadOnly< PropagationLimit >	property_propagation_limit () const
	The limit for which events this controller will handle.

Glib::PropertyProxy< Glib::ustring >	property_name ()
	The name for this controller, typically used for debugging purposes.

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_name () const
	The name for this controller, typically used for debugging purposes.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< EventControllerFocus >	create ()

Static Public Member Functions inherited from Gtk::EventController
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions
	EventControllerFocus ()

Protected Member Functions inherited from Gtk::EventController
	EventController ()
	There is no create() method that corresponds to this constructor, because only derived classes shall be created.

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::EventControllerFocus >	wrap (GtkEventControllerFocus *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gtk::EventController
Glib::RefPtr< Gtk::EventController >	wrap (GtkEventController *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Event controller for focus.

Gtk::EventControllerFocus is an event controller meant for situations where you need to know where the focus is.

Since gtkmm 3.98:

Constructor & Destructor Documentation

◆ EventControllerFocus() [1/2]

Gtk::EventControllerFocus::EventControllerFocus ( EventControllerFocus && src )

noexcept

◆ ~EventControllerFocus()

Gtk::EventControllerFocus::~EventControllerFocus ( )

overridenoexcept

◆ EventControllerFocus() [2/2]

Gtk::EventControllerFocus::EventControllerFocus ( )

protected

Member Function Documentation

◆ contains_focus()

bool Gtk::EventControllerFocus::contains_focus ( ) const

Returns true if focus is within self or one of its children.

Returns: true if focus is within self or one of its children.

◆ create()

static Glib::RefPtr< EventControllerFocus > Gtk::EventControllerFocus::create ( )

static

◆ get_type()

static GType Gtk::EventControllerFocus::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkEventControllerFocus * Gtk::EventControllerFocus::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkEventControllerFocus * Gtk::EventControllerFocus::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkEventControllerFocus * Gtk::EventControllerFocus::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ is_focus()

bool Gtk::EventControllerFocus::is_focus ( ) const

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.

◆ operator=()

EventControllerFocus & Gtk::EventControllerFocus::operator= ( EventControllerFocus && src )

noexcept

◆ property_contains_focus()

Glib::PropertyProxy_ReadOnly< bool > Gtk::EventControllerFocus::property_contains_focus ( ) const

true if focus is contained in the controllers widget.

See property_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_enter() or signal_leave() are emitted.

Default value: false

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_is_focus()

Glib::PropertyProxy_ReadOnly< bool > Gtk::EventControllerFocus::property_is_focus ( ) const

true if focus is in the controllers widget itself, as opposed to in a descendent widget.

◆ signal_enter()

Glib::SignalProxy< void()> Gtk::EventControllerFocus::signal_enter ( )

Slot Prototype:: void on_my_enter()

Flags: Run Last

Emitted whenever the focus enters into the widget or one of its descendents.

Note that this means you may not get an signal_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_is_focus() property for changes.

◆ signal_leave()

Glib::SignalProxy< void()> Gtk::EventControllerFocus::signal_leave ( )

Slot Prototype:: void on_my_leave()

Flags: Run Last

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 signal_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_is_focus() property for changes.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::EventControllerFocus > wrap	(	GtkEventControllerFocus *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols