EmojiChooserProtocol

public protocol EmojiChooserProtocol : PopoverProtocol

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

An example GtkEmojiChooser

GtkEmojiChooser emits the [signalGtk.EmojiChooser::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 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.

The EmojiChooserProtocol protocol exposes the methods and properties of an underlying GtkEmojiChooser instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see EmojiChooser. Alternatively, use EmojiChooserRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkEmojiChooser instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • emoji_chooser_ptr Default implementation

    Typed pointer to the underlying GtkEmojiChooser instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkEmojiChooser instance.

    Declaration

    Swift

    var emoji_chooser_ptr: UnsafeMutablePointer<GtkEmojiChooser>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EmojiChooserProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EmojiChooser Class

  • Bind a EmojiChooserPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: EmojiChooserPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a EmojiChooser property

    Declaration

    Swift

    @inlinable
func get(property: EmojiChooserPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a EmojiChooser property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: EmojiChooserPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EmojiChooser signals

  • Connect a Swift signal handler to the given, typed EmojiChooserSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: EmojiChooserSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed EmojiChooserSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: EmojiChooserSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Emitted when the user selects an Emoji.

    Note

    This represents the underlying emoji-picked signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onEmojiPicked(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: EmojiChooserRef, _ text: String) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    text

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

    The signal handler to call Run the given callback whenever the emojiPicked signal is emitted
    Show on GitHub
  • emojiPickedSignal Extension method

    Typed emoji-picked signal for using the connect(signal:) methods

    Declaration

    Swift

    static var emojiPickedSignal: EmojiChooserSignalName { get }
    Show on GitHub