Interface EntryCompletion.OnEntryCompletionMatchFunc

Enclosing class:
EntryCompletion
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public static interface EntryCompletion.OnEntryCompletionMatchFunc
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    onEntryCompletionMatchFunc(CallbackHandler __self, EntryCompletion completion, Str key, TreeIter iter, Pointer user_data)
    A function which decides whether the row indicated by @iter matches
    a given @key, and should be displayed as a possible completion for @key.
  • Method Details

    • onEntryCompletionMatchFunc

      boolean onEntryCompletionMatchFunc(CallbackHandler __self, @Nonnull EntryCompletion completion, @Nonnull Str key, @Nonnull TreeIter iter, @Nullable Pointer user_data)
      A function which decides whether the row indicated by @iter matches
      a given @key, and should be displayed as a possible completion for @key.

      Note that @key is normalized and case-folded (see g_utf8_normalize()
      and g_utf8_casefold()). If this is not appropriate, match functions
      have access to the unmodified key via
      `gtk_editable_get_text (GTK_EDITABLE (gtk_entry_completion_get_entry ()))`.
      Parameters:
      completion - the `GtkEntryCompletion`
      key - the string to match, normalized and case-folded
      iter - a `GtkTreeIter` indicating the row to match
      user_data - user data given to gtk_entry_completion_set_match_func()
      Returns:
      %TRUE if @iter should be displayed as a possible completion for @key