a11y_profile_manager_profile_validate ()

void
a11y_profile_manager_profile_validate (A11yProfileManagerProfile *self,
                                       GError **error);

Validates the profile manifest and gsettings files found in the profile directory given at object creation time. If required manifest data is not present, or the GSettings data is invalid, #error will be set to ProfileError.

The validity of the profile can be checked with #a11y_profile_manager_profile_get_valid().

Since: 0.1

a11y_profile_manager_profile_set_settings ()

void
a11y_profile_manager_profile_set_settings
                               (A11yProfileManagerProfile *self,
                                GError **error);

Sets the settings as per the profile GSettings file.

Since: 0.1

a11y_profile_manager_profile_reset_settings ()

void
a11y_profile_manager_profile_reset_settings
                               (A11yProfileManagerProfile *self,
                                GError **error);

Resets the settings given in the profile GSettings file to defaults.

Since: 0.1

a11y_profile_manager_profile_write_dconf_file ()

void
a11y_profile_manager_profile_write_dconf_file
                               (A11yProfileManagerProfile *self,
                                const gchar *file,
                                GError **error);

Writes the gsettings data in the profile to a format that is consumable by the dconf command-line utility. The file can be used with 'dconf compile' to create a dconf database with profile settings.

Since: 0.1.2

a11y_profile_manager_profile_new ()

A11yProfileManagerProfile *
a11y_profile_manager_profile_new (const gchar *profile_dir);

Creates a new accessibility profile object.

Since: 0.1

a11y_profile_manager_profile_get_dir_name ()

const gchar *
a11y_profile_manager_profile_get_dir_name
                               (A11yProfileManagerProfile *self);

Get and return the current value of the "dir-name" property.

The directory where the profile files are stored, relative to the profiles directory.

Since: 0.1

a11y_profile_manager_profile_get_name ()

const gchar *
a11y_profile_manager_profile_get_name (A11yProfileManagerProfile *self);

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

The name of the accessibility profile, as per the manifest file.

Since: 0.1

a11y_profile_manager_profile_get_description ()

const gchar *
a11y_profile_manager_profile_get_description
                               (A11yProfileManagerProfile *self);

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

The description of the accessibility profile, as per the manifest file.

Since: 0.1

a11y_profile_manager_profile_get_monitor_schema ()

const gchar *
a11y_profile_manager_profile_get_monitor_schema
                               (A11yProfileManagerProfile *self);

Get and return the current value of the "monitor-schema" property.

The GSettings schema to subscribe to for change events, as per the manifest file.

Since: 0.1

a11y_profile_manager_profile_get_monitor_key ()

const gchar *
a11y_profile_manager_profile_get_monitor_key
                               (A11yProfileManagerProfile *self);

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

THe GSettings key associated with the GSettings schema to monitor, as per the manifest file.

Since: 0.1

a11y_profile_manager_profile_get_at_command ()

const gchar *
a11y_profile_manager_profile_get_at_command
                               (A11yProfileManagerProfile *self);

Get and return the current value of the "at-command" property.

The command to execute to run an assistive technology that best works with this profile.

Since: 0.1.2

a11y_profile_manager_profile_get_valid ()

gboolean
a11y_profile_manager_profile_get_valid
                               (A11yProfileManagerProfile *self);

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

The validity of the accessibility profile, whether the GSettings exist, the manifest is valid, whether settings values are the correct value type, etc.

Since: 0.1

a11y_profile_manager_profile_get_indicator_toggle ()

gboolean
a11y_profile_manager_profile_get_indicator_toggle
                               (A11yProfileManagerProfile *self);

Get and return the current value of the "indicator-toggle" property.

Used to toggle the state of the accessibility profiles indicator. Set to true if writing out profile data to a file for use with dconf.

Since: 0.1.11

a11y_profile_manager_profile_set_indicator_toggle ()

void
a11y_profile_manager_profile_set_indicator_toggle
                               (A11yProfileManagerProfile *self,
                                gboolean value);

Set the value of the "indicator-toggle" property to value .

Used to toggle the state of the accessibility profiles indicator. Set to true if writing out profile data to a file for use with dconf.

Since: 0.1.11

A11Y_PROFILE_MANAGER_TYPE_PROFILE

#define A11Y_PROFILE_MANAGER_TYPE_PROFILE (a11y_profile_manager_profile_get_type ())

The type for A11yProfileManagerProfile.

struct A11yProfileManagerProfile

struct A11yProfileManagerProfile;

This object represents an accessibility profile.

An accessibility profile represents a group of settings that can be enabled to provide a better experience for a user with a disability. An accessibility profile can be associated with an assistive technology service such as the Orca Screen reader if desired.

Only one accessibility profile can be enabled at a time, as the same setting may be present in multiple profiles, and have multiple different values accross different profiles. The accessibility profile manager library currently only supports GSettings for profile configuration at this time.

Since: 0.1

struct A11yProfileManagerProfileClass

struct A11yProfileManagerProfileClass {
	GObjectClass parent_class;
};

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

enum A11yProfileManagerProfileError

Errors which can be thrown when attempting to activate an accessibility profile.

Since: 0.1

The “at-command” property

  “at-command”               gchar *

The command to execute to run an assistive technology that best works with this profile.

Flags: Read

Default value: NULL

Since: 0.1.2

The “description” property

  “description”              gchar *

The description of the accessibility profile, as per the manifest file.

Flags: Read

Default value: NULL

Since: 0.1

The “dir-name” property

  “dir-name”                 gchar *

The directory where the profile files are stored, relative to the profiles directory.

Flags: Read

Default value: NULL

Since: 0.1

The “indicator-toggle” property

  “indicator-toggle”         gboolean

Used to toggle the state of the accessibility profiles indicator. Set to true if writing out profile data to a file for use with dconf.

Flags: Read / Write

Default value: FALSE

Since: 0.1.11

The “monitor-key” property

  “monitor-key”              gchar *

THe GSettings key associated with the GSettings schema to monitor, as per the manifest file.

Flags: Read

Default value: NULL

Since: 0.1

The “monitor-schema” property

  “monitor-schema”           gchar *

The GSettings schema to subscribe to for change events, as per the manifest file.

Flags: Read

Default value: NULL

Since: 0.1

The “name” property

  “name”                     gchar *

The name of the accessibility profile, as per the manifest file.

Flags: Read

Default value: NULL

Since: 0.1

The “valid” property

  “valid”                    gboolean

The validity of the accessibility profile, whether the GSettings exist, the manifest is valid, whether settings values are the correct value type, etc.

Flags: Read

Default value: FALSE

Since: 0.1