Blame doc/reference/html/libxklavier-xkl-engine.html

Packit Service 93d855
Packit Service 93d855
<html>
Packit Service 93d855
<head>
Packit Service 93d855
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service 93d855
<title>XklEngine</title>
Packit Service 93d855
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
Packit Service 93d855
<link rel="home" href="index.html" title="Libxklavier Reference Manual">
Packit Service 93d855
<link rel="up" href="ch01.html" title="Libxklavier Objects">
Packit Service 93d855
<link rel="prev" href="ch01.html" title="Libxklavier Objects">
Packit Service 93d855
<link rel="next" href="XklConfigItem.html" title="XklConfigItem">
Packit Service 93d855
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
Packit Service 93d855
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service 93d855
</head>
Packit Service 93d855
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Prev
Packit Service 93d855
Up
Packit Service 93d855
Home
Packit Service 93d855
Libxklavier Reference Manual
Packit Service 93d855
Next
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Top
Packit Service 93d855
                   | 
Packit Service 93d855
                  Description
Packit Service 93d855
                   | 
Packit Service 93d855
                  Object Hierarchy
Packit Service 93d855
                   | 
Packit Service 93d855
                  Properties
Packit Service 93d855
                   | 
Packit Service 93d855
                  Signals
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XklEngine

Packit Service 93d855

XklEngine

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Synopsis

Packit Service 93d855
                    XklEnginePrivate;
Packit Service 93d855
enum                XklEngineStateChange;
Packit Service 93d855
enum                XklEngineFeatures;
Packit Service 93d855
                    XklState;
Packit Service 93d855
                    XklEngine;
Packit Service 93d855
GType               xkl_engine_features_get_type        (void);
Packit Service 93d855
GType               xkl_engine_listen_modes_get_type    (void);
Packit Service 93d855
GType               xkl_engine_state_change_get_type    (void);
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Object Hierarchy

Packit Service 93d855
Packit Service 93d855
  GObject
Packit Service 93d855
   +----XklEngine
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Properties

Packit Service 93d855
Packit Service 93d855
  "backendName"              gchar*                : Read
Packit Service 93d855
  "default-group"            guint                 : Read
Packit Service 93d855
  "display"                  gpointer              : Read / Write / Construct Only
Packit Service 93d855
  "features"                 XklEngineFeatures     : Read
Packit Service 93d855
  "indicators-handling"      gboolean              : Read
Packit Service 93d855
  "max-num-groups"           guint                 : Read
Packit Service 93d855
  "num-groups"               guint                 : Read
Packit Service 93d855
  "secondary-groups-mask"    guint                 : Read
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Signals

Packit Service 93d855
Packit Service 93d855
  "X-config-changed"                               : Run Last
Packit Service 93d855
  "X-new-device"                                   : Run Last
Packit Service 93d855
  "X-state-changed"                                : Run Last
Packit Service 93d855
  "new-toplevel-window"                            : Run Last
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Description

Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Details

Packit Service 93d855
Packit Service 93d855

XklEnginePrivate

Packit Service 93d855
typedef struct _XklEnginePrivate XklEnginePrivate;
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

enum XklEngineStateChange

Packit Service 93d855
typedef enum {
Packit Service 93d855
		GROUP_CHANGED,
Packit Service 93d855
		INDICATORS_CHANGED
Packit Service 93d855
} XklEngineStateChange;
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
The type of the keyboard state change
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

GROUP_CHANGED

Packit Service 93d855
Group was changed
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

INDICATORS_CHANGED

Packit Service 93d855
Indicators were changed
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

enum XklEngineFeatures

Packit Service 93d855
typedef enum {
Packit Service 93d855
 /*< flags >*/
Packit Service 93d855
		XKLF_CAN_TOGGLE_INDICATORS = 1 << 0,
Packit Service 93d855
		XKLF_CAN_OUTPUT_CONFIG_AS_ASCII = 1 << 1,
Packit Service 93d855
		XKLF_CAN_OUTPUT_CONFIG_AS_BINARY = 1 << 2,
Packit Service 93d855
		XKLF_MULTIPLE_LAYOUTS_SUPPORTED = 1 << 3,
Packit Service 93d855
		XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT = 1 << 4,
Packit Service 93d855
		XKLF_DEVICE_DISCOVERY = 1 << 5
Packit Service 93d855
} XklEngineFeatures;
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
A set of flags used to indicate the capabilities of the active backend
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_CAN_TOGGLE_INDICATORS

Packit Service 93d855
Backend allows to toggls indicators on/off
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_CAN_OUTPUT_CONFIG_AS_ASCII

Packit Service 93d855
Backend allows writing ASCII representation of the configuration
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_CAN_OUTPUT_CONFIG_AS_BINARY

Packit Service 93d855
Backend allows writing binary representation of the configuration
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_MULTIPLE_LAYOUTS_SUPPORTED

Packit Service 93d855
Backend supports multiple layouts
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT

Packit Service 93d855
Backend requires manual configuration, some daemon should do 
Packit Service 93d855
                                  xkl_start_listen(engine,XKLL_MANAGE_LAYOUTS);
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

XKLF_DEVICE_DISCOVERY

Packit Service 93d855
Backend supports device discovery, can notify
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

XklState

Packit Service 93d855
typedef struct _XklState XklState;
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

XklEngine

Packit Service 93d855
typedef struct _XklEngine XklEngine;
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

xkl_engine_features_get_type ()

Packit Service 93d855
GType               xkl_engine_features_get_type        (void);
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

xkl_engine_listen_modes_get_type ()

Packit Service 93d855
GType               xkl_engine_listen_modes_get_type    (void);
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

xkl_engine_state_change_get_type ()

Packit Service 93d855
GType               xkl_engine_state_change_get_type    (void);
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Property Details

Packit Service 93d855
Packit Service 93d855

The "backendName" property

Packit Service 93d855
  "backendName"              gchar*                : Read
Packit Service 93d855

Backend name.

Packit Service 93d855

Default value: NULL

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "default-group" property

Packit Service 93d855
  "default-group"            guint                 : Read
Packit Service 93d855

Default group.

Packit Service 93d855

Allowed values: <= 256

Packit Service 93d855

Default value: 0

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "display" property

Packit Service 93d855
  "display"                  gpointer              : Read / Write / Construct Only
Packit Service 93d855

X Display pointer.

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "features" property

Packit Service 93d855
  "features"                 XklEngineFeatures     : Read
Packit Service 93d855

Backend features.

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "indicators-handling" property

Packit Service 93d855
  "indicators-handling"      gboolean              : Read
Packit Service 93d855

Whether engine should handle indicators.

Packit Service 93d855

Default value: FALSE

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "max-num-groups" property

Packit Service 93d855
  "max-num-groups"           guint                 : Read
Packit Service 93d855

Max number of groups.

Packit Service 93d855

Allowed values: <= 256

Packit Service 93d855

Default value: 0

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "num-groups" property

Packit Service 93d855
  "num-groups"               guint                 : Read
Packit Service 93d855

Current number of groups.

Packit Service 93d855

Allowed values: <= 256

Packit Service 93d855

Default value: 0

Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "secondary-groups-mask" property

Packit Service 93d855
  "secondary-groups-mask"    guint                 : Read
Packit Service 93d855

Secondary groups mask.

Packit Service 93d855

Allowed values: <= 256

Packit Service 93d855

Default value: 0

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Signal Details

Packit Service 93d855
Packit Service 93d855

The "X-config-changed" signal

Packit Service 93d855
void                user_function                      (XklEngine *xklengine,
Packit Service 93d855
                                                        gpointer   user_data)      : Run Last
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

xklengine :

Packit Service 93d855
the object which received the signal.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

user_data :

Packit Service 93d855
user data set when the signal handler was connected.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "X-new-device" signal

Packit Service 93d855
void                user_function                      (XklEngine *xklengine,
Packit Service 93d855
                                                        gpointer   user_data)      : Run Last
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

xklengine :

Packit Service 93d855
the object which received the signal.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

user_data :

Packit Service 93d855
user data set when the signal handler was connected.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "X-state-changed" signal

Packit Service 93d855
void                user_function                      (XklEngine           *xklengine,
Packit Service 93d855
                                                        XklEngineStateChange arg1,
Packit Service 93d855
                                                        gint                 arg2,
Packit Service 93d855
                                                        gboolean             arg3,
Packit Service 93d855
                                                        gpointer             user_data)      : Run Last
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

xklengine :

Packit Service 93d855
the object which received the signal.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

user_data :

Packit Service 93d855
user data set when the signal handler was connected.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
Packit Service 93d855

The "new-toplevel-window" signal

Packit Service 93d855
gint                user_function                      (XklEngine *xklengine,
Packit Service 93d855
                                                        glong      arg1,
Packit Service 93d855
                                                        glong      arg2,
Packit Service 93d855
                                                        gpointer   user_data)      : Run Last
Packit Service 93d855

Packit Service 93d855

Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

xklengine :

Packit Service 93d855
the object which received the signal.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

user_data :

Packit Service 93d855
user data set when the signal handler was connected.
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855
Packit Service 93d855

Packit Service 93d855
          Generated by GTK-Doc V1.18
Packit Service 93d855
</body>
Packit Service 93d855
</html>