Utilities

Utilities — small utilities functions to use imsettings library.

Synopsis

#define             IMSETTINGS_GERROR
enum                IMSettingsError;
GQuark              imsettings_g_error_quark            (void);
GDBusInterfaceInfo * imsettings_get_interface_info      (void);
gboolean            imsettings_is_enabled               (void);

Description

This section describes utilities functions that used in imsettings library.

Details

IMSETTINGS_GERROR

#define IMSETTINGS_GERROR (imsettings_g_error_quark())

Error domain for imsettings. Errors in this domain will be from IMSettingsError enumeration. See GError for information on error domains.

enum IMSettingsError

typedef enum {
	IMSETTINGS_GERROR_UNKNOWN,
	IMSETTINGS_GERROR_CONFIGURATION_ERROR,
	IMSETTINGS_GERROR_IM_NOT_FOUND,
	IMSETTINGS_GERROR_UNABLE_TO_TRACK_IM,
	IMSETTINGS_GERROR_OOM,
	IMSETTINGS_GERROR_NOT_TARGETED_DESKTOP,
} IMSettingsError;

Error codes used in imsettings.

`IMSETTINGS_GERROR_UNKNOWN`	unknown error happened.
`IMSETTINGS_GERROR_CONFIGURATION_ERROR`	misconfigured.
`IMSETTINGS_GERROR_IM_NOT_FOUND`	the Input Method in request doesn't found.
`IMSETTINGS_GERROR_UNABLE_TO_TRACK_IM`	the Input Method isn't managed by imsettings.
`IMSETTINGS_GERROR_OOM`	Out of memory occured.
`IMSETTINGS_GERROR_NOT_TARGETED_DESKTOP`	current desktop isn't targeted by Input Method.

imsettings_g_error_quark ()

GQuark              imsettings_g_error_quark            (void);

imsettings_get_interface_info ()

GDBusInterfaceInfo * imsettings_get_interface_info      (void);

Returns the GDBusInterfaceInfo, if any, specifying the minimal interface that imsettings conforms to.

See the "g-interface-info" property for more details.

Returns :

a GDBusInterfaceInfo or NULL. Do not unref the returned object, it is owned by an instance of GDBusProxy.

imsettings_is_enabled ()

gboolean            imsettings_is_enabled               (void);

Check if current environment are supposed to work with imsettings.

Returns :

TRUE if imsettings is enabled, otherwise FALSE.

			imsettings Documentation
Top \| Description