Include Paths

Manipulating the include paths in a context. More...

Functions
int	xkb_context_include_path_append (struct xkb_context *context, const char *path)
	Append a new entry to the context's include path.
int	xkb_context_include_path_append_default (struct xkb_context *context)
	Append the default include paths to the context's include path.
int	xkb_context_include_path_reset_defaults (struct xkb_context *context)
	Reset the context's include path to the default.
void	xkb_context_include_path_clear (struct xkb_context *context)
	Remove all entries from the context's include path.
unsigned int	xkb_context_num_include_paths (struct xkb_context *context)
	Get the number of paths in the context's include path.
const char *	xkb_context_include_path_get (struct xkb_context *context, unsigned int index)
	Get a specific include path from the context's include path.

Detailed Description

Manipulating the include paths in a context.

The include paths are the file-system paths that are searched when an include statement is encountered during keymap compilation. In most cases, the default include paths are sufficient.

Function Documentation

int xkb_context_include_path_append	(	struct xkb_context *	context,
		const char *	path
	)

Append a new entry to the context's include path.

Returns

1 on success, or 0 if the include path could not be added or is inaccessible.

int xkb_context_include_path_append_default

(

struct xkb_context *

context

)

Append the default include paths to the context's include path.

Returns

1 on success, or 0 if the primary include path could not be added.

int xkb_context_include_path_reset_defaults

(

struct xkb_context *

context

)

Reset the context's include path to the default.

Removes all entries from the context's include path, and inserts the default paths.

Returns

1 on success, or 0 if the primary include path could not be added.

const char * xkb_context_include_path_get	(	struct xkb_context *	context,
		unsigned int	index
	)

Get a specific include path from the context's include path.

Returns

The include path at the specified index. If the index is invalid, returns NULL.