Method

PosOskWidgetset_layout

Declaration [src]

gboolean
pos_osk_widget_set_layout (
  PosOskWidget* self,
  const char* layout_id,
  const char* display_name,
  const char* layout,
  const char* variant,
  GError** error
)

Description [src]

Sets the widgets keyboard layout.

Retruns: TRUE on success, FALSE otherwise.

Parameters

layout_id

Type: const char*

The (xkb) layout id. This can differ from the widget layout and variant e.g. in the case of terminal where we use a terminal layout but an xkb keymap us.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
display_name

Type: const char*

The display name. Should be used when displaying layout information to the user. (E.g. ‘English (US)’)

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
layout

Type: const char*

The name of the layout. E.g. jp, de

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
variant

Type: const char*

The layout variant, e.g. ch

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

No description available.