CaribouScanner

CaribouScanner — Object providing access to keyboard in scanning mode.

Functions

Properties

gboolean autorestart Read / Write / Construct
gboolean bind-settings Read / Write / Construct Only
gboolean inverse-scanning Read / Write / Construct
gchar * keyboard-key Read / Write / Construct
gint mouse-button Read / Write / Construct
gint scan-cycles Read / Write / Construct
gboolean scan-enabled Read / Write / Construct
gint scan-grouping Read / Write / Construct
gdouble step-time Read / Write / Construct
gchar * switch-device Read / Write / Construct

Types and Values

Object Hierarchy

    GObject
    ╰── CaribouScanner

Description

Functions

caribou_scanner_set_keyboard ()

void
caribou_scanner_set_keyboard (CaribouScanner *self,
                              CaribouKeyboardModel *keyboard);

Parameters

self

the CaribouScanner instance

 

keyboard

 

 

caribou_scanner_reset ()

void
caribou_scanner_reset (CaribouScanner *self);

Parameters

self

the CaribouScanner instance

 

caribou_scanner_new ()

CaribouScanner *
caribou_scanner_new (void);

caribou_scanner_get_bind_settings ()

gboolean
caribou_scanner_get_bind_settings (CaribouScanner *self);

Get and return the current value of the "bind-settings" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "bind-settings" property


caribou_scanner_get_scan_grouping ()

gint
caribou_scanner_get_scan_grouping (CaribouScanner *self);

Get and return the current value of the "scan-grouping" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "scan-grouping" property


caribou_scanner_set_scan_grouping ()

void
caribou_scanner_set_scan_grouping (CaribouScanner *self,
                                   gint value);

Set the value of the "scan-grouping" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "scan-grouping" property

 

caribou_scanner_get_scan_enabled ()

gboolean
caribou_scanner_get_scan_enabled (CaribouScanner *self);

Get and return the current value of the "scan-enabled" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "scan-enabled" property


caribou_scanner_set_scan_enabled ()

void
caribou_scanner_set_scan_enabled (CaribouScanner *self,
                                  gboolean value);

Set the value of the "scan-enabled" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "scan-enabled" property

 

caribou_scanner_get_step_time ()

gdouble
caribou_scanner_get_step_time (CaribouScanner *self);

Get and return the current value of the "step-time" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "step-time" property


caribou_scanner_set_step_time ()

void
caribou_scanner_set_step_time (CaribouScanner *self,
                               gdouble value);

Set the value of the "step-time" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "step-time" property

 

caribou_scanner_get_switch_device ()

const gchar *
caribou_scanner_get_switch_device (CaribouScanner *self);

Get and return the current value of the "switch-device" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "switch-device" property


caribou_scanner_set_switch_device ()

void
caribou_scanner_set_switch_device (CaribouScanner *self,
                                   const gchar *value);

Set the value of the "switch-device" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "switch-device" property

 

caribou_scanner_get_keyboard_key ()

const gchar *
caribou_scanner_get_keyboard_key (CaribouScanner *self);

Get and return the current value of the "keyboard-key" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "keyboard-key" property


caribou_scanner_set_keyboard_key ()

void
caribou_scanner_set_keyboard_key (CaribouScanner *self,
                                  const gchar *value);

Set the value of the "keyboard-key" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "keyboard-key" property

 

caribou_scanner_get_mouse_button ()

gint
caribou_scanner_get_mouse_button (CaribouScanner *self);

Get and return the current value of the "mouse-button" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "mouse-button" property


caribou_scanner_set_mouse_button ()

void
caribou_scanner_set_mouse_button (CaribouScanner *self,
                                  gint value);

Set the value of the "mouse-button" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "mouse-button" property

 

caribou_scanner_get_scan_cycles ()

gint
caribou_scanner_get_scan_cycles (CaribouScanner *self);

Get and return the current value of the "scan-cycles" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "scan-cycles" property


caribou_scanner_set_scan_cycles ()

void
caribou_scanner_set_scan_cycles (CaribouScanner *self,
                                 gint value);

Set the value of the "scan-cycles" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "scan-cycles" property

 

caribou_scanner_get_autorestart ()

gboolean
caribou_scanner_get_autorestart (CaribouScanner *self);

Get and return the current value of the "autorestart" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "autorestart" property


caribou_scanner_set_autorestart ()

void
caribou_scanner_set_autorestart (CaribouScanner *self,
                                 gboolean value);

Set the value of the "autorestart" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "autorestart" property

 

caribou_scanner_get_inverse_scanning ()

gboolean
caribou_scanner_get_inverse_scanning (CaribouScanner *self);

Get and return the current value of the "inverse-scanning" property.

Parameters

self

the CaribouScanner instance to query

 

Returns

the value of the "inverse-scanning" property


caribou_scanner_set_inverse_scanning ()

void
caribou_scanner_set_inverse_scanning (CaribouScanner *self,
                                      gboolean value);

Set the value of the "inverse-scanning" property to value .

Parameters

self

the CaribouScanner instance to modify

 

value

the new value of the "inverse-scanning" property

 

Types and Values

CARIBOU_TYPE_SCANNER

#define CARIBOU_TYPE_SCANNER (caribou_scanner_get_type ())

The type for CaribouScanner.


struct CaribouScanner

struct CaribouScanner;

Object providing access to keyboard in scanning mode.


struct CaribouScannerClass

struct CaribouScannerClass {
	GObjectClass parent_class;
};

The class structure for CARIBOU_TYPE_SCANNER. All the fields in this structure are private and should never be accessed directly.

Members

Property Details

The “autorestart” property

  “autorestart”              gboolean

autorestart.

Flags: Read / Write / Construct

Default value: FALSE


The “bind-settings” property

  “bind-settings”            gboolean

bind-settings.

Flags: Read / Write / Construct Only

Default value: TRUE


The “inverse-scanning” property

  “inverse-scanning”         gboolean

inverse-scanning.

Flags: Read / Write / Construct

Default value: FALSE


The “keyboard-key” property

  “keyboard-key”             gchar *

keyboard-key.

Flags: Read / Write / Construct

Default value: NULL


The “mouse-button” property

  “mouse-button”             gint

mouse-button.

Flags: Read / Write / Construct

Default value: 0


The “scan-cycles” property

  “scan-cycles”              gint

scan-cycles.

Flags: Read / Write / Construct

Default value: 1


The “scan-enabled” property

  “scan-enabled”             gboolean

scan-enabled.

Flags: Read / Write / Construct

Default value: FALSE


The “scan-grouping” property

  “scan-grouping”            gint

scan-grouping.

Flags: Read / Write / Construct

Default value: 0


The “step-time” property

  “step-time”                gdouble

step-time.

Flags: Read / Write / Construct

Default value: 0


The “switch-device” property

  “switch-device”            gchar *

switch-device.

Flags: Read / Write / Construct

Default value: NULL