ClutterDeviceManager: Clutter Reference Manual

ClutterDeviceManager

ClutterDeviceManager — Maintains the list of input devices

Functions

ClutterDeviceManager *	clutter_device_manager_get_default ()
GSList *	clutter_device_manager_list_devices ()
const GSList *	clutter_device_manager_peek_devices ()
ClutterInputDevice *	clutter_device_manager_get_device ()
ClutterInputDevice *	clutter_device_manager_get_core_device ()
ClutterVirtualInputDevice *	clutter_device_manager_create_virtual_device ()
ClutterVirtualDeviceType	clutter_device_manager_get_supported_virtual_device_types ()
void	clutter_device_manager_set_kbd_a11y_settings ()
void	clutter_device_manager_get_kbd_a11y_settings ()

Properties

ClutterBackend *

backend

Read / Write / Construct Only

Signals

void	device-added	Run Last
void	device-removed	Run Last
void	kbd-a11y-flags-changed	Run Last
void	kbd-a11y-mods-state-changed	Run Last
void	tool-changed	Run Last

Types and Values

enum	ClutterVirtualDeviceType
struct	ClutterDeviceManager
struct	ClutterDeviceManagerClass

Object Hierarchy

    GObject
    ╰── ClutterDeviceManager

Description

ClutterDeviceManager is a singleton object, owned by Clutter, which maintains the list of ClutterInputDevices.

Depending on the backend used by Clutter it is possible to use the “device-added” and “device-removed” to monitor addition and removal of devices.

ClutterDeviceManager is available since Clutter 1.2

Functions

clutter_device_manager_get_default ()

ClutterDeviceManager *
clutter_device_manager_get_default (void);

Retrieves the device manager singleton

Returns

the ClutterDeviceManager singleton. The returned instance is owned by Clutter and it should not be modified or freed.

[transfer none]

Since: 1.2

clutter_device_manager_list_devices ()

GSList *
clutter_device_manager_list_devices (ClutterDeviceManager *device_manager);

Lists all currently registered input devices

Parameters

device_manager

a ClutterDeviceManager

Returns

a newly allocated list of ClutterInputDevice objects. Use g_slist_free() to deallocate it when done.

[transfer container][element-type Clutter.InputDevice]

Since: 1.2

clutter_device_manager_peek_devices ()

const GSList *
clutter_device_manager_peek_devices (ClutterDeviceManager *device_manager);

Lists all currently registered input devices

Parameters

device_manager

a ClutterDeviceManager

Returns

a pointer to the internal list of ClutterInputDevice objects. The returned list is owned by the ClutterDeviceManager and should never be modified or freed.

[transfer none][element-type Clutter.InputDevice]

Since: 1.2

clutter_device_manager_get_device ()

ClutterInputDevice *
clutter_device_manager_get_device (ClutterDeviceManager *device_manager,
                                   gint device_id);

Retrieves the ClutterInputDevice with the given device_id

Parameters

device_manager	a ClutterDeviceManager
device_id	the integer id of a device

Returns

a ClutterInputDevice or NULL. The returned device is owned by the ClutterDeviceManager and should never be modified or freed.

[transfer none]

Since: 1.2

clutter_device_manager_get_core_device ()

ClutterInputDevice *
clutter_device_manager_get_core_device
                               (ClutterDeviceManager *device_manager,
                                ClutterInputDeviceType device_type);

Retrieves the core ClutterInputDevice of type device_type

Core devices are devices created automatically by the default Clutter backend

Parameters

device_manager	a ClutterDeviceManager
device_type	the type of the core device

Returns

a ClutterInputDevice or NULL. The returned device is owned by the ClutterDeviceManager and should not be modified or freed.

[transfer none]

Since: 1.2

clutter_device_manager_create_virtual_device ()

ClutterVirtualInputDevice *
clutter_device_manager_create_virtual_device
                               (ClutterDeviceManager *device_manager,
                                ClutterInputDeviceType device_type);

Creates a virtual input device.

Parameters

device_manager	a ClutterDeviceManager
device_type	the type of the virtual device

Returns

a newly created virtual device.

[transfer full]

clutter_device_manager_get_supported_virtual_device_types ()

ClutterVirtualDeviceType
clutter_device_manager_get_supported_virtual_device_types
                               (ClutterDeviceManager *device_manager);

clutter_device_manager_set_kbd_a11y_settings ()

void
clutter_device_manager_set_kbd_a11y_settings
                               (ClutterDeviceManager *device_manager,
                                ClutterKbdA11ySettings *settings);

clutter_device_manager_get_kbd_a11y_settings ()

void
clutter_device_manager_get_kbd_a11y_settings
                               (ClutterDeviceManager *device_manager,
                                ClutterKbdA11ySettings *settings);

Types and Values

enum ClutterVirtualDeviceType

Members

CLUTTER_VIRTUAL_DEVICE_TYPE_NONE
CLUTTER_VIRTUAL_DEVICE_TYPE_KEYBOARD
CLUTTER_VIRTUAL_DEVICE_TYPE_POINTER
CLUTTER_VIRTUAL_DEVICE_TYPE_TOUCHSCREEN

struct ClutterDeviceManager

struct ClutterDeviceManager;

The ClutterDeviceManager structure contains only private data

Since: 1.2

struct ClutterDeviceManagerClass

struct ClutterDeviceManagerClass {
};

The ClutterDeviceManagerClass structure contains only private data

Since: 1.2

Property Details

The `“backend”` property

  “backend”                  ClutterBackend *

The ClutterBackend of the device manager.

Owner: ClutterDeviceManager

Flags: Read / Write / Construct Only

Signal Details

The `“device-added”` signal

void
user_function (ClutterDeviceManager *manager,
               ClutterInputDevice   *device,
               gpointer              user_data)

The ::device-added signal is emitted each time a device has been added to the ClutterDeviceManager

Parameters

manager	the ClutterDeviceManager that emitted the signal
device	the newly added ClutterInputDevice
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 1.2

The `“device-removed”` signal

void
user_function (ClutterDeviceManager *manager,
               ClutterInputDevice   *device,
               gpointer              user_data)

The ::device-removed signal is emitted each time a device has been removed from the ClutterDeviceManager

Parameters

manager	the ClutterDeviceManager that emitted the signal
device	the removed ClutterInputDevice
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 1.2

The `“kbd-a11y-flags-changed”` signal

void
user_function (ClutterDeviceManager *manager,
               guint                 settings_flags,
               guint                 changed_mask,
               gpointer              user_data)

The ::kbd-a11y-flags-changed signal is emitted each time the ClutterKeyboardA11yFlags configuration is changed as the result of keyboard accessibilty operations.

Parameters

manager	the ClutterDeviceManager that emitted the signal
settings_flags	the new ClutterKeyboardA11yFlags configuration
changed_mask	the ClutterKeyboardA11yFlags changed
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“kbd-a11y-mods-state-changed”` signal

void
user_function (ClutterDeviceManager *manager,
               guint                 latched_mask,
               guint                 locked_mask,
               gpointer              user_data)

The ::kbd-a11y-mods-state-changed signal is emitted each time either the latched modifiers mask or locked modifiers mask are changed as the result of keyboard accessibilty's sticky keys operations.

Parameters

manager	the ClutterDeviceManager that emitted the signal
latched_mask	the latched modifier mask from stickykeys
locked_mask	the locked modifier mask from stickykeys
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“tool-changed”` signal

void
user_function (ClutterDeviceManager   *clutterdevicemanager,
               ClutterInputDevice     *arg1,
               ClutterInputDeviceTool *arg2,
               gpointer                user_data)

Flags: Run Last