Struct gtk4::EventControllerFocus

#[repr(transparent)]
pub struct EventControllerFocus { /* private fields */ }

EventControllerFocus is an event controller to keep track of keyboard focus.

The event controller offers enter and leave signals, as well as is-focus and contains-focus properties which are updated to reflect focus changes inside the widget hierarchy that is rooted at the controllers widget.

Properties

contains-focus

true if focus is contained in the controllers widget.

See is-focus for whether the focus is in the widget itself or inside a descendent.

When handling focus events, this property is updated before enter or leave are emitted.

Readable

is-focus

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

See also contains-focus.

When handling focus events, this property is updated before enter or leave are emitted.

Readable

EventController

name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

widget

The widget receiving the GdkEvents that the controller will handle.

Readable

Signals

enter

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 is-focus property for changes.

leave

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 is-focus property for changes.

Implements

EventControllerExt, glib::ObjectExt

Implementations

impl EventControllerFocus

pub fn new() -> EventControllerFocus

Creates a new event controller that will handle focus events.

Returns

a new EventControllerFocus

pub fn builder() -> EventControllerFocusBuilder

Creates a new builder-pattern struct instance to construct EventControllerFocus objects.

This method returns an instance of EventControllerFocusBuilder which can be used to create EventControllerFocus objects.

pub fn contains_focus(&self) -> bool

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

Returns

true if focus is within @self or one of its children

pub fn is_focus(&self) -> bool

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

pub fn connect_enter<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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 is-focus property for changes.

pub fn connect_leave<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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 is-focus property for changes.

pub fn connect_contains_focus_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_is_focus_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for EventControllerFocus

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventControllerFocus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EventControllerFocus

fn default() -> Self

Returns the “default value” for a type.

impl Display for EventControllerFocus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for EventControllerFocus

type ParamSpec = ParamSpecObject

type SetValue = EventControllerFocus

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, EventControllerFocus>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EventControllerFocus

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EventControllerFocus

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for EventControllerFocus

type Parent = EventController

impl<OT: ObjectType> PartialEq<OT> for EventControllerFocus

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for EventControllerFocus

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for EventControllerFocus

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for EventControllerFocus

impl IsA<EventController> for EventControllerFocus