Class

GtkEmojiChooser

Description [src]

final class Gtk.EmojiChooser : Gtk.Popover
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Native, Gtk.ShortcutManager {
  /* No available fields */
}

The GtkEmojiChooser is used by text widgets such as GtkEntry or GtkTextView to let users insert Emoji characters.

An example GtkEmojiChooser

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

Shortcuts and Gestures

GtkEmojiChooser supports the following keyboard shortcuts:

  • Ctrl+N scrolls th the next section.
  • Ctrl+P scrolls th the previous section.

Actions

GtkEmojiChooser defines a set of built-in actions:

  • scroll.section scrolls to the next or previous section.

CSS nodes

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

Every GtkEmojiChooser 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.

Hierarchy

hierarchy this GtkEmojiChooser implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkNative this--implements_3 implements_4 GtkShortcutManager this--implements_4 ancestor_0 GtkPopover ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

Constructors

gtk_emoji_chooser_new

Creates a new GtkEmojiChooser.

Instance methods

Methods inherited from GtkPopover (20)
gtk_popover_get_autohide

Returns whether the popover is modal.

gtk_popover_get_cascade_popdown

Returns whether the popover will close after a modal child is closed.

gtk_popover_get_child

Gets the child widget of popover.

gtk_popover_get_has_arrow

Gets whether this popover is showing an arrow pointing at the widget that it is relative to.

gtk_popover_get_mnemonics_visible

Gets whether mnemonics are visible.

gtk_popover_get_offset

Gets the offset previous set with [method@Gtk.Popover.set_offset()].

gtk_popover_get_pointing_to

Gets the rectangle that the popover points to.

gtk_popover_get_position

Returns the preferred position of popover.

gtk_popover_popdown

Pops popover down.

gtk_popover_popup

Pops popover up.

gtk_popover_present

Allocate a size for the GtkPopover.

gtk_popover_set_autohide

Sets whether popover is modal.

gtk_popover_set_cascade_popdown

If cascade_popdown is TRUE, the popover will be closed when a child modal popover is closed.

gtk_popover_set_child

Sets the child widget of popover.

gtk_popover_set_default_widget

Sets the default widget of a GtkPopover.

gtk_popover_set_has_arrow

Sets whether this popover should draw an arrow pointing at the widget it is relative to.

gtk_popover_set_mnemonics_visible

Sets whether mnemonics should be visible.

gtk_popover_set_offset

Sets the offset to use when calculating the position of the popover.

gtk_popover_set_pointing_to

Sets the rectangle that popover points to.

gtk_popover_set_position

Sets the preferred position for popover to appear.

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Queries a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkNative (5)
gtk_native_get_renderer

Returns the renderer that is used for this GtkNative.

gtk_native_get_surface

Returns the surface of this GtkNative.

gtk_native_get_surface_transform

Retrieves the surface transform of self.

gtk_native_realize

Realizes a GtkNative.

gtk_native_unrealize

Unrealizes a GtkNative.

Properties

Properties inherited from GtkPopover (8)
Gtk.Popover:autohide

Whether to dismiss the popover on outside clicks.

Gtk.Popover:cascade-popdown

Whether the popover pops down after a child popover.

Gtk.Popover:child

The child widget.

Gtk.Popover:default-widget

The default widget inside the popover.

Gtk.Popover:has-arrow

Whether to draw an arrow.

Gtk.Popover:mnemonics-visible

Whether mnemonics are currently visible in this popover.

Gtk.Popover:pointing-to

Rectangle in the parent widget that the popover points to.

Gtk.Popover:position

How to place the popover, relative to its parent.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the GtkWidget::query-tooltip signal on widget.

Gtk.Widget:height-request

Overrides for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Overrides for width request of the widget.

Properties inherited from GtkAccessible (1)
GtkAccessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Signals

Gtk.EmojiChooser::emoji-picked

Emitted when the user selects an Emoji.

Signals inherited from GtkPopover (2)
GtkPopover::activate-default

Emitted whend the user activates the default widget.

GtkPopover::closed

Emitted when the popover is closed.

Signals inherited from GtkWidget (13)
GtkWidget::destroy

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

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkEmojiChooserClass {
  /* no available fields */
}

No description available.