Struct gtk4::EmojiChooser

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

The EmojiChooser is used by text widgets such as Entry or TextView to let users insert Emoji characters.

EmojiChooser emits the emoji-picked signal when an Emoji is selected.

CSS nodes

popover
├── box.emoji-searchbar
│   ╰── entry.search
╰── box.emoji-toolbar
    ├── button.image-button.emoji-section
    ├── ...
    ╰── button.image-button.emoji-section

Every EmojiChooser consists of a main node called popover. The contents of the popover are largely implementation defined and supposed to inherit general styles. The top searchbar used to search emoji and gets the .emoji-searchbar style class itself. The bottom toolbar used to switch between different emoji categories consists of buttons with the .emoji-section style class and gets the .emoji-toolbar style class itself.

Signals

emoji-picked

Emitted when the user selects an Emoji.

Popover

activate-default

Emitted whend the user activates the default widget.

This is a keybinding signal.

Action

closed

Emitted when the popover is closed.

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

PopoverExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, ShortcutManagerExt, WidgetExtManual, AccessibleExtManual

Implementations

impl EmojiChooser

pub fn new() -> EmojiChooser

Creates a new EmojiChooser.

Returns

a new EmojiChooser

pub fn builder() -> EmojiChooserBuilder

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

This method returns an instance of EmojiChooserBuilder which can be used to create EmojiChooser objects.

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

Emitted when the user selects an Emoji.

text

the Unicode sequence for the picked Emoji, in UTF-8

Trait Implementations

impl Clone for EmojiChooser

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 EmojiChooser

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

Formats the value using the given formatter.

impl Default for EmojiChooser

fn default() -> Self

Returns the “default value” for a type.

impl Display for EmojiChooser

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

Formats the value using the given formatter.

impl HasParamSpec for EmojiChooser

type ParamSpec = ParamSpecObject

type SetValue = EmojiChooser

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for EmojiChooser

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 EmojiChooser

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 EmojiChooser

type Parent = Popover

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

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 EmojiChooser

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 EmojiChooser

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for EmojiChooser

impl IsA<Accessible> for EmojiChooser

impl IsA<Buildable> for EmojiChooser

impl IsA<ConstraintTarget> for EmojiChooser

impl IsA<Native> for EmojiChooser

impl IsA<Popover> for EmojiChooser

impl IsA<ShortcutManager> for EmojiChooser

impl IsA<Widget> for EmojiChooser