Documentation

Context is the exposed datatype of an xkbcommon context (struct xkb_context)

ContextFlags carry options for construction of a Context. (enum xkb_context_flags)

Default ContextFlags: consider RMLVO prefs from the environment variables, and search for Keymap files in the default paths.

Pure ContextFlags: don't consider env vars or default search paths, which are system-dependent.

Construct a new Xkb context from creation preferences. xkb_context_new can fail if the default include path does not exist.

(xkb_context_new)

Get the current include paths of a Context. Upon Keymap creation, these directories will be searched for keymap definitions.

Set a new list of include paths for a Context.

Append a search path for Keymap files to a Context. (xkb_context_include_path_append)

Preferred API is to use getIncludePaths and setIncludePaths

(xkb_context_num_include_paths)

Preferred API is to use getIncludePaths and setIncludePaths

Remove all Keymap file search paths from a Context.

Preferred API is to use getIncludePaths and setIncludePaths

(xkb_context_include_path_clear)

Append the default Keymap search path (whose location depends on libxkbcommon compile-time settings) (xkb_context_include_path_append_default)

Preferred API is to use getIncludePaths and setIncludePaths

Get a specific include path from the context's include path. (xkb_context_include_path_get)

Preferred API is to use getIncludePaths and setIncludePaths