Class (GI Struct)

GLib-2.0 ▶ GLib ▶ CompletionDeprecated 2.26

GLib.Completion provides support for automatic completion of a string using any group of target strings. It is typically used for file name completion as is common in many UNIX shells.

A GLib.Completion is created using GLib.Completion.new. Target items are added and removed with GLib.Completion.add_items, GLib.Completion.remove_items and GLib.Completion.clear_items. A completion attempt is requested with GLib.Completion.complete or GLib.Completion.complete_utf8. When no longer needed, the GLib.Completion is freed with GLib.Completion.free.

Items in the completion can be simple strings (e.g. filenames), or pointers to arbitrary data structures. If data structures are used you must provide a GLib.CompletionFunc in GLib.Completion.new, which retrieves the item’s string from the data structure. You can change the way in which strings are compared by setting a different GLib.CompletionStrncmpFunc in GLib.Completion.set_compare.

GLib.Completion has been marked as deprecated, since this API is rarely used and not very actively maintained.

since 2.26: Rarely used API

Index

Constructors

constructor

Properties

cache func items prefix strncmp_func $gtype

Methods

clear_items complete_utf8 free

Constructors

Properties

cache: any[]
func: CompletionFunc
items: any[]
prefix: string
strncmp_func: CompletionStrncmpFunc
$gtype: GType<GLib.Completion>

Methods

  • Removes all items from the GLib.Completion. The items are not freed, so if the memory was dynamically allocated, it should be freed after calling this function.

    Returns void

  • Attempts to complete the string prefix using the GLib.Completion target items. In contrast to g_completion_complete(), this function returns the largest common prefix that is a valid UTF-8 string, omitting a possible common partial character.

    You should use this function instead of g_completion_complete() if your items are UTF-8 strings.

    Parameters

    • Deprecatedprefix: string

      the prefix string, typically used by the user, which is compared with each of the items

    • Deprecatednew_prefix: string

      if non-null, returns the longest prefix which is common to all items that matched prefix, or null if no items matched prefix. This string should be freed when no longer needed.

    Returns string[]

    the list of items whose strings begin with prefix. This should not be changed.

  • Frees all memory used by the GLib.Completion. The items are not freed, so if the memory was dynamically allocated, it should be freed after calling this function.

    Returns void