EekXkbLayout

EekXkbLayout — Layout engine using XKB configuration

Synopsis

struct              EekXkbLayout;
struct              EekXkbLayoutClass;
EekLayout *         eek_xkb_layout_new                  (void);
gboolean            eek_xkb_layout_set_names            (EekXkbLayout *layout,
                                                         XkbComponentNamesRec *names);
gboolean            eek_xkb_layout_set_names_full       (EekXkbLayout *layout,
                                                         ...);
gboolean            eek_xkb_layout_set_names_full_valist
                                                        (EekXkbLayout *layout,
                                                         va_list var_args);
gboolean            eek_xkb_layout_set_keycodes         (EekXkbLayout *layout,
                                                         const gchar *keycodes);
gboolean            eek_xkb_layout_set_geometry         (EekXkbLayout *layout,
                                                         const gchar *geometry);
gboolean            eek_xkb_layout_set_symbols          (EekXkbLayout *layout,
                                                         const gchar *symbols);
const gchar *       eek_xkb_layout_get_keycodes         (EekXkbLayout *layout);
const gchar *       eek_xkb_layout_get_geometry         (EekXkbLayout *layout);
const gchar *       eek_xkb_layout_get_symbols          (EekXkbLayout *layout);
                    EekXkbLayoutPrivate;

Object Hierarchy

  GObject
   +----EekLayout
         +----EekXkbLayout
               +----EekXklLayout

Properties

  "geometry"                 gchar*                : Read / Write
  "keycodes"                 gchar*                : Read / Write
  "symbols"                  gchar*                : Read / Write

Description

The EekXkbLayout inherits EekLayout class and arranges keyboard elements using XKB.

Details

struct EekXkbLayout

struct EekXkbLayout;

struct EekXkbLayoutClass

struct EekXkbLayoutClass {
};

eek_xkb_layout_new ()

EekLayout *         eek_xkb_layout_new                  (void);

Create a new EekXkbLayout.


eek_xkb_layout_set_names ()

gboolean            eek_xkb_layout_set_names            (EekXkbLayout *layout,
                                                         XkbComponentNamesRec *names);

Set the XKB component names to layout.

layout :

an EekXkbLayout

names :

XKB component names

Returns :

TRUE if any of the component names changed, FALSE otherwise

eek_xkb_layout_set_names_full ()

gboolean            eek_xkb_layout_set_names_full       (EekXkbLayout *layout,
                                                         ...);

Set the XKB component names to layout. This function is merely a wrapper around eek_xkb_layout_set_names() to avoid passing a pointer of XkbComponentNamesRec, which is not currently available in the gobject-introspection repository.

Available component names are: keymap, keycodes, types, compat, symbols, geometry.

layout :

an EekXkbLayout

Varargs :

pairs of component name and value, terminated by NULL.

Returns :

TRUE if the component name is successfully set, FALSE otherwise

Since 0.0.2


eek_xkb_layout_set_names_full_valist ()

gboolean            eek_xkb_layout_set_names_full_valist
                                                        (EekXkbLayout *layout,
                                                         va_list var_args);

See eek_xkb_layout_set_names_full(), this version takes a va_list for language bindings to use.

layout :

an EekXkbLayout

var_args :

va_list of pairs of component name and value.

Since 0.0.5


eek_xkb_layout_set_keycodes ()

gboolean            eek_xkb_layout_set_keycodes         (EekXkbLayout *layout,
                                                         const gchar *keycodes);

Set the keycodes component (in the XKB terminology).

layout :

an EekXkbLayout

keycodes :

component name for keycodes

Returns :

TRUE if the component name is successfully set, FALSE otherwise

eek_xkb_layout_set_geometry ()

gboolean            eek_xkb_layout_set_geometry         (EekXkbLayout *layout,
                                                         const gchar *geometry);

layout :

an EekXkbLayout

geometry :

component name for geometry

Returns :

TRUE if the component name is successfully set, FALSE otherwise

eek_xkb_layout_set_symbols ()

gboolean            eek_xkb_layout_set_symbols          (EekXkbLayout *layout,
                                                         const gchar *symbols);

Set the symbols component (in the XKB terminology).

layout :

an EekXkbLayout

symbols :

component name for symbols

Returns :

TRUE if the component name is successfully set, FALSE otherwise

eek_xkb_layout_get_keycodes ()

const gchar *       eek_xkb_layout_get_keycodes         (EekXkbLayout *layout);

Get the keycodes component name (in the XKB terminology).

layout :

an EekXkbLayout

eek_xkb_layout_get_geometry ()

const gchar *       eek_xkb_layout_get_geometry         (EekXkbLayout *layout);

Get the geometry component name (in the XKB terminology).

layout :

an EekXkbLayout

eek_xkb_layout_get_symbols ()

const gchar *       eek_xkb_layout_get_symbols          (EekXkbLayout *layout);

Get the symbols component name (in the XKB terminology).

layout :

an EekXkbLayout

EekXkbLayoutPrivate

typedef struct _EekXkbLayoutPrivate EekXkbLayoutPrivate;

Property Details

The "geometry" property

  "geometry"                 gchar*                : Read / Write

XKB geometry component name.

Default value: NULL


The "keycodes" property

  "keycodes"                 gchar*                : Read / Write

XKB keycodes component name.

Default value: NULL


The "symbols" property

  "symbols"                  gchar*                : Read / Write

XKB symbols component name.

Default value: NULL